Represents a logical connection with a remote peer, identified by a QUIC connection ID.

Each QuicSession maintains a number of QUIC streams, identified by their QUIC stream ID; Each QUIC stream is wrapped in an EndPoint, namely QuicStreamEndPoint.

Bytes received from a QuicConnection in process(SocketAddress, ByteBuffer) are passed to Quiche for processing; in turn, Quiche produces a list of QUIC stream IDs that have pending I/O events, either read-ready or write-ready.

On the receive side, a QuicSession fans-out to multiple QuicStreamEndPoints.

On the send side, many QuicStreamEndPoints fan-in to a QuicSession.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	QuicSession.Flusher
public static interface	QuicSession.Listener A listener for `QuicSession` events.

Field Summary

Modifier and Type	Field and Description
private final ByteBufferPool	byteBufferPool
private final QuicConnection	connection
private final ConcurrentMap<Long, QuicStreamEndPoint>	endPoints
private final Executor	executor
private final QuicSession.Flusher	flusher
private long	idleTimeout
private final AtomicLong[]	ids
private static final Logger	LOG Hides org.eclipse.jetty.util.component.ContainerLifeCycle.LOG.
private volatile ProtocolSession	protocolSession
private final QuicheConnection	quicheConnection
private QuicheConnectionId	quicheConnectionId
private SocketAddress	remoteAddress
private final Scheduler	scheduler

Constructor Summary

Access	Constructor and Description
protected	QuicSession(Executor executor, Scheduler scheduler, ByteBufferPool byteBufferPool, QuicheConnection quicheConnection, QuicConnection connection, SocketAddress remoteAddress)

Method Summary

Modifier and Type	Method and Description
protected abstract ProtocolSession	createProtocolSession()
protected void	doStart() Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.doStart. Starts the managed lifecycle beans in the order they were added.
protected void	doStop() Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.doStop. Stops the managed lifecycle beans in the reverse order they were added.
public void	dump(Appendable out, String indent) Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.dump. Implements org.eclipse.jetty.util.component.Dumpable.dump. Dump this object (and children) into an Appendable using the provided indent after any new lines.
public int	fill(long streamId, ByteBuffer buffer)
private void	finishOutwardClose(Throwable failure)
public int	flush(long streamId, ByteBuffer buffer, boolean last)
public void	flush()
public ByteBufferPool	getByteBufferPool()
public QuicheConnectionId	getConnectionId()
public Executor	getExecutor()
public long	getIdleTimeout()
public SocketAddress	getLocalAddress()
public int	getMaxLocalStreams()
public String	getNegotiatedProtocol()
public QuicStreamEndPoint	getOrCreateStreamEndPoint(long streamId, Consumer<QuicStreamEndPoint> consumer)
public ProtocolSession	getProtocolSession()
public QuicConnection	getQuicConnection()
public Collection<QuicStreamEndPoint>	getQuicStreamEndPoints()
pack-priv List<Long>	getReadableStreamIds()
public SocketAddress	getRemoteAddress()
public CloseInfo	getRemoteCloseInfo()
public Scheduler	getScheduler()
pack-priv QuicStreamEndPoint	getStreamEndPoint(long streamId)
public long	getWindowCapacity()
public long	getWindowCapacity(long streamId)
pack-priv List<Long>	getWritableStreamIds()
public void	inwardClose(long error, String reason)
public boolean	isConnectionEstablished()
public boolean	isFinished(long streamId)
public abstract Connection	newConnection(QuicStreamEndPoint endPoint)
private QuicStreamEndPoint	newQuicStreamEndPoint(long streamId)
public long	newStreamId(StreamType the stream type streamType) Returns: a new stream ID for the given type
private void	notifyClosed(QuicSession.Listener listener)
private void	notifyOpened(QuicSession.Listener listener)
public void	onFailure(Throwable failure)
public boolean	onIdleTimeout()
public void	outwardClose(long error, String reason)
protected Runnable	pollTask()
public Runnable	process(SocketAddress remoteAddress, ByteBuffer cipherBufferIn)
public void	remove(QuicStreamEndPoint endPoint, Throwable failure)
public void	setConnectionId(QuicheConnectionId quicheConnectionId)
public void	setIdleTimeout(long idleTimeout)
public CompletableFuture<Void>	shutdown()
public void	shutdownInput(long streamId, long error)
public void	shutdownOutput(long streamId, long error)
public String	toString() Overrides org.eclipse.jetty.util.component.AbstractLifeCycle.toString. Returns a string representation of the object.

Field Detail

byteBufferPool	back to summary
private final ByteBufferPool byteBufferPool

connection	back to summary
private final QuicConnection connection

endPoints	back to summary
private final ConcurrentMap<Long, QuicStreamEndPoint> endPoints

executor	back to summary
private final Executor executor

flusher	back to summary
private final QuicSession.Flusher flusher

idleTimeout	back to summary
private long idleTimeout

ids	back to summary
private final AtomicLong[] ids

LOG	back to summary
private static final Logger LOG Hides org.eclipse.jetty.util.component.ContainerLifeCycle.LOG.

protocolSession	back to summary
private volatile ProtocolSession protocolSession

quicheConnection	back to summary
private final QuicheConnection quicheConnection

quicheConnectionId	back to summary
private QuicheConnectionId quicheConnectionId

remoteAddress	back to summary
private SocketAddress remoteAddress

scheduler	back to summary
private final Scheduler scheduler

Constructor Detail

QuicSession	back to summary
protected QuicSession(Executor executor, Scheduler scheduler, ByteBufferPool byteBufferPool, QuicheConnection quicheConnection, QuicConnection connection, SocketAddress remoteAddress)

Method Detail

createProtocolSession	back to summary
protected abstract ProtocolSession createProtocolSession()

doStart	back to summary
protected void doStart() throws Exception Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.doStart. Doc from org.eclipse.jetty.util.component.ContainerLifeCycle.doStart. Starts the managed lifecycle beans in the order they were added. Annotations @Override Exceptions Exception: Doc from org.eclipse.jetty.util.component.AbstractLifeCycle.doStart. If there was a problem starting. Will cause a transition to FAILED state

doStart

back to summary

protected void doStart() throws Exception

Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.doStart.

Doc from org.eclipse.jetty.util.component.ContainerLifeCycle.doStart.

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

Annotations

@Override

Exceptions

Exception:

Doc from org.eclipse.jetty.util.component.AbstractLifeCycle.doStart.

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

doStop	back to summary
protected void doStop() throws Exception Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.doStop. Doc from org.eclipse.jetty.util.component.ContainerLifeCycle.doStop. Stops the managed lifecycle beans in the reverse order they were added. Annotations @Override Exceptions Exception: Doc from org.eclipse.jetty.util.component.AbstractLifeCycle.doStop. If there was a problem stopping. Will cause a transition to FAILED state

doStop

back to summary

protected void doStop() throws Exception

Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.doStop.

Doc from org.eclipse.jetty.util.component.ContainerLifeCycle.doStop.

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

Annotations

@Override

Exceptions

Exception:

Doc from org.eclipse.jetty.util.component.AbstractLifeCycle.doStop.

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

dump	back to summary
public void dump(Appendable out, String indent) throws IOException Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.dump. Implements org.eclipse.jetty.util.component.Dumpable.dump. Doc from org.eclipse.jetty.util.component.Dumpable.dump. 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. Annotations @Override Exceptions IOException: if unable to write to Appendable

dump

back to summary

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

Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.dump.

Implements org.eclipse.jetty.util.component.Dumpable.dump.

Doc from org.eclipse.jetty.util.component.Dumpable.dump.

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.

Annotations

@Override

Exceptions

IOException:: if unable to write to Appendable

fill	back to summary
public int fill(long streamId, ByteBuffer buffer) throws IOException

finishOutwardClose	back to summary
private void finishOutwardClose(Throwable failure)

flush	back to summary
public int flush(long streamId, ByteBuffer buffer, boolean last) throws IOException

flush	back to summary
public void flush()

getByteBufferPool	back to summary
public ByteBufferPool getByteBufferPool()

getConnectionId	back to summary
public QuicheConnectionId getConnectionId()

getExecutor	back to summary
public Executor getExecutor()

getIdleTimeout	back to summary
public long getIdleTimeout()

getLocalAddress	back to summary
public SocketAddress getLocalAddress()

getMaxLocalStreams	back to summary
public int getMaxLocalStreams()

getNegotiatedProtocol	back to summary
public String getNegotiatedProtocol()

getOrCreateStreamEndPoint	back to summary
public QuicStreamEndPoint getOrCreateStreamEndPoint(long streamId, Consumer<QuicStreamEndPoint> consumer)

getProtocolSession	back to summary
public ProtocolSession getProtocolSession()

getQuicConnection	back to summary
public QuicConnection getQuicConnection()

getQuicStreamEndPoints	back to summary
public Collection<QuicStreamEndPoint> getQuicStreamEndPoints()

getReadableStreamIds	back to summary
pack-priv List<Long> getReadableStreamIds()

getRemoteAddress	back to summary
public SocketAddress getRemoteAddress()

getRemoteCloseInfo	back to summary
public CloseInfo getRemoteCloseInfo()

getScheduler	back to summary
public Scheduler getScheduler()

getStreamEndPoint	back to summary
pack-priv QuicStreamEndPoint getStreamEndPoint(long streamId)

getWindowCapacity	back to summary
public long getWindowCapacity()

getWindowCapacity	back to summary
public long getWindowCapacity(long streamId) throws IOException

getWritableStreamIds	back to summary
pack-priv List<Long> getWritableStreamIds()

inwardClose	back to summary
public void inwardClose(long error, String reason)

isConnectionEstablished	back to summary
public boolean isConnectionEstablished()

isFinished	back to summary
public boolean isFinished(long streamId)

newConnection	back to summary
public abstract Connection newConnection(QuicStreamEndPoint endPoint)

newQuicStreamEndPoint	back to summary
private QuicStreamEndPoint newQuicStreamEndPoint(long streamId)

newStreamId	back to summary
public long newStreamId(StreamType streamType) Parameters streamType:StreamType the stream type Returns:long a new stream ID for the given type

notifyClosed	back to summary
private void notifyClosed(QuicSession.Listener listener)

notifyOpened	back to summary
private void notifyOpened(QuicSession.Listener listener)

onFailure	back to summary
public void onFailure(Throwable failure)

onIdleTimeout	back to summary
public boolean onIdleTimeout()

outwardClose	back to summary
public void outwardClose(long error, String reason)

pollTask	back to summary
protected Runnable pollTask()

process	back to summary
public Runnable process(SocketAddress remoteAddress, ByteBuffer cipherBufferIn) throws IOException

remove	back to summary
public void remove(QuicStreamEndPoint endPoint, Throwable failure)

setConnectionId	back to summary
public void setConnectionId(QuicheConnectionId quicheConnectionId)

setIdleTimeout	back to summary
public void setIdleTimeout(long idleTimeout)

shutdown	back to summary
public CompletableFuture<Void> shutdown()

shutdownInput	back to summary
public void shutdownInput(long streamId, long error) throws IOException

shutdownOutput	back to summary
public void shutdownOutput(long streamId, long error) throws IOException

toString back to summary

public String toString()

Overrides org.eclipse.jetty.util.component.AbstractLifeCycle.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

org.eclipse.jetty.quic.common back to summary

private Class QuicSession.Flusher

Class Inheritance

extends IteratingCallback

java.lang.Object
org.eclipse.jetty.util.IteratingCallback
org.eclipse.jetty.quic.common.QuicSession.Flusher

Field Summary

Modifier and Type	Field and Description
private RetainableByteBuffer	cipherBuffer
private final CyclicTimeout	timeout

Constructor Summary

Access	Constructor and Description
public	Flusher(Scheduler scheduler)

Method Summary

Modifier and Type	Method and Description
private void	finish(Throwable failure)
public Invocable.InvocationType	getInvocationType() Overrides default org.eclipse.jetty.util.thread.Invocable.getInvocationType.
protected void	onCompleteFailure(Throwable failure) Overrides org.eclipse.jetty.util.IteratingCallback.onCompleteFailure. Invoked when the overall task has completed with a failure.
protected void	onCompleteSuccess() Overrides org.eclipse.jetty.util.IteratingCallback.onCompleteSuccess. Invoked when the overall task has completed successfully.
protected IteratingCallback.Action	process() Implements abstract org.eclipse.jetty.util.IteratingCallback.process. Method called by `iterate()` to process the asynchronous sub-task.
public void	succeeded() Overrides org.eclipse.jetty.util.IteratingCallback.succeeded. Overrides default org.eclipse.jetty.util.Callback.succeeded. Method to invoke when the asynchronous sub-task succeeds.

Inherited from org.eclipse.jetty.util.IteratingCallback:: abort close failed isAborted isClosed isFailed isSucceeded iterate reset toString

Field Detail

cipherBuffer	back to summary
private RetainableByteBuffer cipherBuffer

timeout	back to summary
private final CyclicTimeout timeout

Constructor Detail

Flusher	back to summary
public Flusher(Scheduler scheduler)

Method Detail

finish	back to summary
private void finish(Throwable failure)

getInvocationType

back to summary

public Invocable.InvocationType getInvocationType()

Overrides default org.eclipse.jetty.util.thread.Invocable.getInvocationType.

Annotations

@Override

onCompleteFailure

back to summary

protected void onCompleteFailure(Throwable failure)

Overrides org.eclipse.jetty.util.IteratingCallback.onCompleteFailure.

Doc from org.eclipse.jetty.util.IteratingCallback.onCompleteFailure.

Invoked when the overall task has completed with a failure.

Annotations

@Override

onCompleteSuccess

back to summary

protected void onCompleteSuccess()

Overrides org.eclipse.jetty.util.IteratingCallback.onCompleteSuccess.

Doc from org.eclipse.jetty.util.IteratingCallback.onCompleteSuccess.

Invoked when the overall task has completed successfully.

Annotations

@Override

process back to summary

protected IteratingCallback.Action process() throws IOException

Implements abstract org.eclipse.jetty.util.IteratingCallback.process.

Doc from org.eclipse.jetty.util.IteratingCallback.process.

Method called by iterate() to process the asynchronous sub-task.

Implementations must initiate the asynchronous execution of the sub-task (if any) and return an appropriate action:

Action#IDLE when no sub tasks are available for execution but the overall job is not completed yet
Action#SCHEDULED when the sub task asynchronous execution has been started
Action#SUCCEEDED when the overall job is completed

Annotations

@Override

succeeded back to summary

public void succeeded()

Overrides org.eclipse.jetty.util.IteratingCallback.succeeded.

Overrides default org.eclipse.jetty.util.Callback.succeeded.

Doc from org.eclipse.jetty.util.IteratingCallback.succeeded.

Method to invoke when the asynchronous sub-task succeeds.

Subclasses that override this method must always remember to call super.succeeded().

Annotations

@Override

org.eclipse.jetty.quic.common back to summary

public Interface QuicSession.Listener

Known Direct Implementers: org.eclipse.jetty.quic.common.QuicSessionContainer

A listener for QuicSession events.

Method Summary

Modifier and Type	Method and Description
public default void	onClosed(QuicSession the session session) Callback method invoked when a `QuicSession` is closed.
public default void	onOpened(QuicSession the session session) Callback method invoked when a `QuicSession` is opened.

Method Detail

onClosed back to summary

public default void onClosed(QuicSession session)

Callback method invoked when a QuicSession is closed.

Parameters

session:QuicSession: the session

onOpened back to summary

public default void onOpened(QuicSession session)

Callback method invoked when a QuicSession is opened.

Parameters

session:QuicSession: the session

public abstract Class QuicSession

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class QuicSession.Flusher

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface QuicSession.Listener

Method Summary

Method Detail