Class ProtocolSession

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.quic.common.ProtocolSession

All Implemented Interfaces:

Container, Destroyable, Dumpable, Dumpable.DumpableContainer, LifeCycle

Direct Known Subclasses:

ClientProtocolSession, ServerProtocolSession

public abstract class ProtocolSession
extends ContainerLifeCycle

Represents an established stateful connection with a remote peer for a specific QUIC connection.

ProtocolSession is created only when the connection is established, and it is protocol specific, depending on the protocol negotiated during the connection establishment, or explicitly configured.

ProtocolSession creates and manages StreamEndPoints, so that protocols on top of QUIC can view QUIC streams as if they were an EndPoint.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ProtocolSession.Factory	A factory for protocol specific instances of ProtocolSession.

Nested classes/interfaces inherited from class AbstractLifeCycle

AbstractLifeCycle.AbstractLifeCycleListener, AbstractLifeCycle.StopException

Nested classes/interfaces inherited from interface Container

Container.InheritedListener, Container.Listener

Nested classes/interfaces inherited from interface Dumpable

Dumpable.DumpableContainer, Dumpable.DumpAppendable

Nested classes/interfaces inherited from interface LifeCycle

LifeCycle.Listener

Field Summary

Fields inherited from class AbstractLifeCycle

FAILED, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface Dumpable

LEGEND

Constructor Summary

Constructors

Constructor	Description
ProtocolSession(Executor executor, ByteBufferPool byteBufferPool, Session session)

Method Summary

Modifier and Type	Method	Description
void	close(ConnectionCloseFrame frame, Promise.Invocable<ProtocolSession> promise)	Performs an inward close upon sending a CONNECTION_CLOSE frame.
StreamEndPoint	createStreamEndPoint(Stream stream, Consumer<StreamEndPoint> initializer)
void	disconnect(ConnectionCloseFrame frame, Throwable failure, Promise.Invocable<ProtocolSession> promise)	Performs an outward disconnection.
protected void	doStart()	Starts the managed lifecycle beans in the order they were added.
protected void	doStop()	Stops the managed lifecycle beans in the reverse order they were added.
void	dump(Appendable out, String indent)	Dump this object (and children) into an Appendable using the provided indent after any new lines.
ByteBufferPool	getByteBufferPool()
Executor	getExecutor()
Session	getSession()
StreamEndPoint	getStreamEndPoint(long streamId)
Collection<StreamEndPoint>	getStreamEndPoints()
protected abstract Connection	newConnection(StreamEndPoint endPoint)
void	offerTask(Runnable task, boolean dispatch)
void	onClose(ConnectionCloseFrame frame)	Performs an inward close upon receiving a CONNECTION_CLOSE frame.
boolean	onIdleTimeout(TimeoutException timeout)
protected void	onStart()
protected void	onStop()
void	onStreamFailure(long streamId, Throwable failure)
void	openStreamEndPoint(StreamEndPoint endPoint)
boolean	removeStreamEndPoint(StreamEndPoint endPoint)
CompletableFuture<ProtocolSession>	shutdown()

Methods inherited from class ContainerLifeCycle

addBean, addBean, addEventListener, addManaged, contains, destroy, 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 AbstractLifeCycle

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

Methods inherited from class Object

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

Methods inherited from interface Container

getCachedBeans, getEventListeners

Methods inherited from interface Dumpable

dumpSelf

Methods inherited from interface Dumpable.DumpableContainer

isDumpable

Constructor Details

ProtocolSession

public ProtocolSession(Executor executor,
 ByteBufferPool byteBufferPool,
 Session session)

Method Details

getExecutor

public Executor getExecutor()

getByteBufferPool

public ByteBufferPool getByteBufferPool()

getSession

public Session getSession()

doStart

protected void doStart()
                throws Exception

Description copied from class: ContainerLifeCycle

Starts the managed lifecycle beans in the order they were added.

Overrides:

doStart in class ContainerLifeCycle

Throws:

Exception - If there was a problem starting. Will cause a transition to FAILED state

onStart

protected void onStart()

doStop

protected void doStop()
               throws Exception

Description copied from class: ContainerLifeCycle

Stops the managed lifecycle beans in the reverse order they were added.

Overrides:

doStop in class ContainerLifeCycle

Throws:

Exception - If there was a problem stopping. Will cause a transition to FAILED state

onStop

protected void onStop()

getStreamEndPoint

public StreamEndPoint getStreamEndPoint(long streamId)

createStreamEndPoint

public StreamEndPoint createStreamEndPoint(Stream stream,
 Consumer<StreamEndPoint> initializer)

removeStreamEndPoint

public boolean removeStreamEndPoint(StreamEndPoint endPoint)

getStreamEndPoints

public Collection<StreamEndPoint> getStreamEndPoints()

openStreamEndPoint

public void openStreamEndPoint(StreamEndPoint endPoint)

newConnection

protected abstract Connection newConnection(StreamEndPoint endPoint)
                                     throws IOException

Throws:

IOException

shutdown

public CompletableFuture<ProtocolSession> shutdown()

onIdleTimeout

public boolean onIdleTimeout(TimeoutException timeout)

onStreamFailure

public void onStreamFailure(long streamId,
 Throwable failure)

close

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

Performs an inward close upon sending a CONNECTION_CLOSE frame.

This method closes all the Connections associated with the StreamEndPoints managed by this class. In turn, the Connection typically closes its associated StreamEndPoint, causing it to be removed from this class. Lastly, it calls disconnect(ConnectionCloseFrame, Throwable, Promise.Invocable).

Parameters:

frame - the frame carrying the error code and reason

promise - a Promise that completes when the frame send completes

See Also:

• Session.close(ConnectionCloseFrame, Promise.Invocable)

onClose

public void onClose(ConnectionCloseFrame frame)

Performs an inward close upon receiving a CONNECTION_CLOSE frame.

The behavior is identical to close(ConnectionCloseFrame, Promise.Invocable).

Parameters:

frame - the frame carrying the error code and reason

disconnect

public void disconnect(ConnectionCloseFrame frame,
 Throwable failure,
 Promise.Invocable<ProtocolSession> promise)

Performs an outward disconnection.

Parameters:

frame - the frame carrying the error code and reason

failure - the failure that caused the disconnect, or null

promise - the Promise that gets notified when the disconnect is complete

See Also:

• Session.disconnect(ConnectionCloseFrame, Throwable, Promise.Invocable)

offerTask

public void offerTask(Runnable task,
 boolean dispatch)

Parameters:

task - The task to offer to the execution strategy.

dispatch - true to dispatch the task, false to produce in the calling thread. Callers from application threads should use true, otherwise they may be arbitrarily delayed. Callers from I/O threads should use false to avoid thread hops.

dump

public void dump(Appendable out,
 String indent)
          throws IOException

Description copied from interface: Dumpable

Dump this object (and children) into an Appendable using the provided indent after any new lines. The indent should not be applied to the first object dumped.

Specified by:

dump in interface Dumpable

Overrides:

dump in class ContainerLifeCycle

Parameters:

out - The appendable to dump to

indent - The indent to apply after any new lines.

Throws:

IOException - if unable to write to Appendable