Class AbstractSession

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.quic.common.AbstractSession

All Implemented Interfaces:

Session, Container, Destroyable, Dumpable, Dumpable.DumpableContainer, LifeCycle

Direct Known Subclasses:

QuicheSession

public abstract class AbstractSession
extends ContainerLifeCycle
implements Session

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AbstractSession.Listener

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

AbstractLifeCycle.AbstractLifeCycleListener, AbstractLifeCycle.StopException

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container

Container.InheritedListener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable

Dumpable.DumpableContainer, Dumpable.DumpAppendable

Field Summary

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

LEGEND

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSession(Executor executor, QuicConfiguration configuration, Session.Listener listener)

Method Summary

Modifier and Type	Method	Description
void	close(ConnectionCloseFrame frame, Promise.Invocable<Session> promise)	Closes this session with the given CONNECTION_CLOSE frame.
protected void	emitDisconnect()
protected void	emitOpen()
Executor	getExecutor()
Session.Listener	getListener()
abstract X509Certificate[]	getPeerCertificates()
QuicConfiguration	getQuicConfiguration()
protected void	notifyClose(ConnectionCloseFrame frame)
protected void	notifyDataBlocked(DataBlockedFrame frame)
protected void	notifyDisconnect()
protected boolean	notifyIdleTimeout(TimeoutException failure)
protected void	notifyLocalClose(ConnectionCloseFrame frame, Promise.Invocable<Session> promise)
protected void	notifyMaxData(MaxDataFrame frame)
protected void	notifyMaxStreams(MaxStreamsFrame frame)
protected Stream.Listener	notifyNewStream()
protected void	notifyOpen()
protected void	notifyPing()
protected TransportParameters	notifyPrepare()
protected void	notifyStreamsBlocked(StreamsBlockedFrame frame)
protected void	notifyTransportParameters(TransportParameters parameters)
abstract void	offerTask(Runnable task)
CompletableFuture<Session>	shutdown()
String	toString()

Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

addBean, addBean, addEventListener, addManaged, contains, destroy, doStart, doStop, dump, dump, dump, dumpObjects, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, installBean, installBean, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, start, stop, unmanage, updateBean, updateBean, updateBeans, updateBeans

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

getEventListeners, getState, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, setEventListeners, start, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.jetty.util.component.Container

getCachedBeans, getEventListeners

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

dumpSelf

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable.DumpableContainer

isDumpable

Methods inherited from interface org.eclipse.jetty.quic.api.Session

disconnect, getId, getIdleTimeout, getLocalBidirectionalMaxStreams, getLocalSocketAddress, getRemoteSocketAddress, getStream, getStreams, maxData, maxStreams, newStream, newStreamId, ping

Constructor Details

AbstractSession

protected AbstractSession(Executor executor,
 QuicConfiguration configuration,
 Session.Listener listener)

Method Details

getExecutor

public Executor getExecutor()

getQuicConfiguration

public QuicConfiguration getQuicConfiguration()

getListener

public Session.Listener getListener()

getPeerCertificates

public abstract X509Certificate[] getPeerCertificates()

emitOpen

protected void emitOpen()

emitDisconnect

protected void emitDisconnect()

offerTask

public abstract void offerTask(Runnable task)

shutdown

public CompletableFuture<Session> shutdown()

close

public void close(ConnectionCloseFrame frame,
 Promise.Invocable<Session> promise)

Description copied from interface: Session

Closes this session with the given CONNECTION_CLOSE frame.

Applications should use this method in conjunction with ConnectionCloseFrame(long, String).

Differently from Session.disconnect(ConnectionCloseFrame, Throwable, Promise.Invocable), this method performs close actions inwards, towards the application, that may perform additional actions such as writing to the network, for example close frames for a protocol on top of QUIC.

After finishing the inward actions, Session.disconnect(ConnectionCloseFrame, Throwable, Promise.Invocable) should be called to perform close actions outwards and eventually send the QUIC close frame and finally disconnect at the network level, if necessary.

Specified by:

close in interface Session

Parameters:

frame - the frame carrying the error code and reason

promise - the Callback that gets notified when the close is complete

notifyOpen

protected void notifyOpen()

notifyNewStream

protected Stream.Listener notifyNewStream()

notifyPrepare

protected TransportParameters notifyPrepare()

notifyTransportParameters

protected void notifyTransportParameters(TransportParameters parameters)

notifyMaxStreams

protected void notifyMaxStreams(MaxStreamsFrame frame)

notifyDataBlocked

protected void notifyDataBlocked(DataBlockedFrame frame)

notifyMaxData

protected void notifyMaxData(MaxDataFrame frame)

notifyPing

protected void notifyPing()

notifyStreamsBlocked

protected void notifyStreamsBlocked(StreamsBlockedFrame frame)

notifyIdleTimeout

protected boolean notifyIdleTimeout(TimeoutException failure)

notifyLocalClose

protected void notifyLocalClose(ConnectionCloseFrame frame,
 Promise.Invocable<Session> promise)

notifyClose

protected void notifyClose(ConnectionCloseFrame frame)

notifyDisconnect

protected void notifyDisconnect()

toString

public String toString()

Overrides:

toString in class AbstractLifeCycle