Package org.eclipse.jetty.http2

Class HTTP2Session

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.http2.HTTP2Session

All Implemented Interfaces:

Session, ISession, Parser.Listener, Container, Destroyable, Dumpable, Dumpable.DumpableContainer, LifeCycle

Direct Known Subclasses:

HTTP2ClientSession, HTTP2ServerSession

@ManagedObject
public abstract class HTTP2Session
extends ContainerLifeCycle
implements ISession, Parser.Listener

Nested Class Summary

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, Container.Listener

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

Dumpable.DumpableContainer

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

LifeCycle.Listener

Nested classes/interfaces inherited from interface org.eclipse.jetty.http2.parser.Parser.Listener

Parser.Listener.Adapter, Parser.Listener.Wrapper

Nested classes/interfaces inherited from interface org.eclipse.jetty.http2.api.Session

Session.Listener

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

KEY

Constructor Summary

Constructors

Constructor	Description
HTTP2Session(Scheduler scheduler, EndPoint endPoint, Parser parser, Generator generator, Session.Listener listener, FlowControlStrategy flowControl, int initialStreamId)

Method Summary

Modifier and Type	Method	Description
protected void	abort(String reason, Throwable failure, Callback callback)
boolean	close(int error, String reason, Callback callback)	Invoked internally and by applications to send a GO_AWAY frame to the other peer.
protected IStream	createLocalStream(int streamId, MetaData.Request request, Consumer<Throwable> failFn)
protected IStream	createRemoteStream(int streamId, MetaData.Request request)
void	data(IStream stream, Callback callback, DataFrame frame)	Enqueues the given DATA frame to be written to the connection.
void	disconnect()
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.
void	frames(IStream stream, List<? extends Frame> frames, Callback callback)	Enqueues the given frames to be written to the connection.
long	getBytesWritten()
CloseState	getCloseState()
EndPoint	getEndPoint()
FlowControlStrategy	getFlowControlStrategy()
Generator	getGenerator()
int	getInitialSessionRecvWindow()
protected int	getLastRemoteStreamId()
InetSocketAddress	getLocalAddress()
SocketAddress	getLocalSocketAddress()
int	getMaxEncoderTableCapacity()
int	getMaxLocalStreams()
int	getMaxRemoteStreams()
Parser	getParser()
int	getRecvWindow()
InetSocketAddress	getRemoteAddress()
SocketAddress	getRemoteSocketAddress()
int	getSendWindow()
IStream	getStream(int streamId)	Retrieves the stream with the given streamId.
int	getStreamCount()
long	getStreamIdleTimeout()
Collection<Stream>	getStreams()
long	getStreamsClosed()
long	getStreamsOpened()
int	getWriteThreshold()
boolean	goAway(GoAwayFrame frame, Callback callback)
protected static boolean	isClientStream(int streamId)
boolean	isClosed()
boolean	isConnectProtocolEnabled()
boolean	isDisconnected()
protected boolean	isLocalStreamClosed(int streamId)
boolean	isPushEnabled()
protected boolean	isRemoteStreamClosed(int streamId)
protected IStream	newStream(int streamId, MetaData.Request request, boolean local)
void	newStream(HeadersFrame frame, Promise<Stream> promise, Stream.Listener listener)	Sends the given HEADERS frame to create a new Stream.
void	newStream(IStream.FrameList frames, Promise<Stream> promise, Stream.Listener listener)	Sends the given list of frames to create a new Stream.
Stream	newUpgradeStream(HeadersFrame frame, Stream.Listener listener, Consumer<Throwable> failFn)	Creates a new stream allocating a stream id if the given HEADERS frame does not have one.
protected void	notifyClose(Session session, GoAwayFrame frame, Callback callback)
protected void	notifyFailure(Session session, Throwable failure, Callback callback)
protected void	notifyGoAway(Session session, GoAwayFrame frame)
protected void	notifyHeaders(IStream stream, HeadersFrame frame)
protected boolean	notifyIdleTimeout(Session session)
protected Stream.Listener	notifyNewStream(Stream stream, HeadersFrame frame)
protected void	notifyPing(Session session, PingFrame frame)
protected void	notifyReset(Session session, ResetFrame frame)
protected void	notifySettings(Session session, SettingsFrame frame)
void	onConnectionFailure(int error, String reason)
void	onData(DataFrame frame)
void	onData(DataFrame frame, Callback callback)	Callback method invoked when a DATA frame is received.
void	onFlushed(long bytes)	Callback method invoked when bytes are flushed to the network.
void	onFrame(Frame frame)	Callback method invoked during an HTTP/1.1 to HTTP/2 upgrade requests to process the given synthetic frame.
void	onGoAway(GoAwayFrame frame)	This method is called when receiving a GO_AWAY from the other peer.
abstract void	onHeaders(HeadersFrame frame)
boolean	onIdleTimeout()	This method is invoked when the idle timeout expires.
void	onPing(PingFrame frame)
void	onPriority(PriorityFrame frame)
void	onReset(ResetFrame frame)
protected void	onResetForUnknownStream(ResetFrame frame)
void	onSettings(SettingsFrame frame)
void	onSettings(SettingsFrame frame, boolean reply)
void	onShutdown()	This method is called when the TCP FIN is received from the remote peer.
void	onStreamFailure(int streamId, int error, String reason)
protected final void	onStreamOpened(IStream stream)
void	onWindowUpdate(WindowUpdateFrame frame)
void	onWindowUpdate(IStream stream, WindowUpdateFrame frame)	Callback method invoked when a WINDOW_UPDATE frame has been received.
void	ping(PingFrame frame, Callback callback)	Sends the given PING frame.
int	priority(PriorityFrame frame, Callback callback)	Sends the given PRIORITY frame.
void	push(IStream stream, Promise<Stream> promise, PushPromiseFrame frame, Stream.Listener listener)	Enqueues the given PUSH_PROMISE frame to be written to the connection.
boolean	removeStream(IStream stream)	Removes the given stream.
void	setConnectProtocolEnabled(boolean connectProtocolEnabled)
void	setInitialSessionRecvWindow(int initialSessionRecvWindow)
void	setMaxEncoderTableCapacity(int maxEncoderTableCapacity)
void	setMaxLocalStreams(int maxLocalStreams)
void	setMaxRemoteStreams(int maxRemoteStreams)
void	setStreamIdleTimeout(long streamIdleTimeout)
void	settings(SettingsFrame frame, Callback callback)	Sends the given SETTINGS frame to configure the session.
void	setWriteThreshold(int writeThreshold)
CompletableFuture<Void>	shutdown()	Gracefully closes the session, returning a CompletableFuture that is completed when all the streams currently being processed are completed.
String	toString()
protected void	updateLastRemoteStreamId(int streamId)
int	updateRecvWindow(int delta)	Updates the session receive window by the given delta.
int	updateSendWindow(int delta)	Updates the session send window by the given delta.

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

addBean, addBean, addEventListener, addManaged, contains, destroy, doStart, dump, dump, dumpObjects, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, 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.http2.parser.Parser.Listener

onPushPromise

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

newStream

Constructor Details

HTTP2Session

public HTTP2Session(Scheduler scheduler,
 EndPoint endPoint,
 Parser parser,
 Generator generator,
 Session.Listener listener,
 FlowControlStrategy flowControl,
 int initialStreamId)

Method Details

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

getFlowControlStrategy

@ManagedAttribute(value="The flow control strategy",
                  readonly=true)
public FlowControlStrategy getFlowControlStrategy()

getStreamsOpened

@ManagedAttribute(value="The total number of streams opened",
                  readonly=true)
public long getStreamsOpened()

getStreamsClosed

@ManagedAttribute(value="The total number of streams closed",
                  readonly=true)
public long getStreamsClosed()

getMaxLocalStreams

@ManagedAttribute("The maximum number of concurrent local streams")
public int getMaxLocalStreams()

setMaxLocalStreams

public void setMaxLocalStreams(int maxLocalStreams)

getMaxRemoteStreams

@ManagedAttribute("The maximum number of concurrent remote streams")
public int getMaxRemoteStreams()

setMaxRemoteStreams

public void setMaxRemoteStreams(int maxRemoteStreams)

getStreamIdleTimeout

@ManagedAttribute("The stream\'s idle timeout")
public long getStreamIdleTimeout()

setStreamIdleTimeout

public void setStreamIdleTimeout(long streamIdleTimeout)

getInitialSessionRecvWindow

@ManagedAttribute("The initial size of session\'s flow control receive window")
public int getInitialSessionRecvWindow()

setInitialSessionRecvWindow

public void setInitialSessionRecvWindow(int initialSessionRecvWindow)

getWriteThreshold

@ManagedAttribute("The number of bytes that trigger a TCP write")
public int getWriteThreshold()

setWriteThreshold

public void setWriteThreshold(int writeThreshold)

getMaxEncoderTableCapacity

@ManagedAttribute("The HPACK encoder dynamic table maximum capacity")
public int getMaxEncoderTableCapacity()

setMaxEncoderTableCapacity

public void setMaxEncoderTableCapacity(int maxEncoderTableCapacity)

getEndPoint

public EndPoint getEndPoint()

getParser

public Parser getParser()

getGenerator

public Generator getGenerator()

getBytesWritten

public long getBytesWritten()

Specified by:

getBytesWritten in interface ISession

Returns:

the number of bytes written by this session

onData

public void onData(DataFrame frame)

Specified by:

onData in interface Parser.Listener

onData

public void onData(DataFrame frame,
 Callback callback)

Description copied from interface: ISession

Callback method invoked when a DATA frame is received.

Specified by:

onData in interface ISession

Parameters:

frame - the DATA frame received

callback - the callback to notify when the frame has been processed

isLocalStreamClosed

protected boolean isLocalStreamClosed(int streamId)

isRemoteStreamClosed

protected boolean isRemoteStreamClosed(int streamId)

onHeaders

public abstract void onHeaders(HeadersFrame frame)

Specified by:

onHeaders in interface Parser.Listener

onPriority

public void onPriority(PriorityFrame frame)

Specified by:

onPriority in interface Parser.Listener

onReset

public void onReset(ResetFrame frame)

Specified by:

onReset in interface Parser.Listener

onResetForUnknownStream

protected void onResetForUnknownStream(ResetFrame frame)

onSettings

public void onSettings(SettingsFrame frame)

Specified by:

onSettings in interface Parser.Listener

onSettings

public void onSettings(SettingsFrame frame,
 boolean reply)

onPing

public void onPing(PingFrame frame)

Specified by:

onPing in interface Parser.Listener

onGoAway

public void onGoAway(GoAwayFrame frame)

This method is called when receiving a GO_AWAY from the other peer.

Specified by:

onGoAway in interface Parser.Listener

Parameters:

frame - the GO_AWAY frame that has been received.

See Also:

• close(int, String, Callback)
• onShutdown()
• onIdleTimeout()

onWindowUpdate

public void onWindowUpdate(WindowUpdateFrame frame)

Specified by:

onWindowUpdate in interface Parser.Listener

onWindowUpdate

public void onWindowUpdate(IStream stream,
 WindowUpdateFrame frame)

Description copied from interface: ISession

Callback method invoked when a WINDOW_UPDATE frame has been received.

Specified by:

onWindowUpdate in interface ISession

Parameters:

stream - the stream the window update belongs to, or null if the window update belongs to the session

frame - the WINDOW_UPDATE frame received

onStreamFailure

public void onStreamFailure(int streamId,
 int error,
 String reason)

Specified by:

onStreamFailure in interface Parser.Listener

onConnectionFailure

public void onConnectionFailure(int error,
 String reason)

Specified by:

onConnectionFailure in interface Parser.Listener

abort

protected void abort(String reason,
 Throwable failure,
 Callback callback)

newStream

public void newStream(HeadersFrame frame,
 Promise<Stream> promise,
 Stream.Listener listener)

Description copied from interface: Session

Sends the given HEADERS frame to create a new Stream.

Specified by:

newStream in interface Session

Parameters:

frame - the HEADERS frame containing the HTTP headers

promise - the promise that gets notified of the stream creation

listener - the listener that gets notified of stream events

newStream

public void newStream(IStream.FrameList frames,
 Promise<Stream> promise,
 Stream.Listener listener)

Description copied from interface: ISession

Sends the given list of frames to create a new Stream.

Specified by:

newStream in interface ISession

Parameters:

frames - the list of frames to send

promise - the promise that gets notified of the stream creation

listener - the listener that gets notified of stream events

newUpgradeStream

public Stream newUpgradeStream(HeadersFrame frame,
 Stream.Listener listener,
 Consumer<Throwable> failFn)

Creates a new stream allocating a stream id if the given HEADERS frame does not have one.

Parameters:

frame - the HEADERS frame that triggered the stream creation allocated stream id, or null if not interested in the modified headers frame

listener - the listener that gets notified of stream events

newStream

protected IStream newStream(int streamId,
 MetaData.Request request,
 boolean local)

priority

public int priority(PriorityFrame frame,
 Callback callback)

Description copied from interface: Session

Sends the given PRIORITY frame.

If the frame references a streamId that does not exist (for example 0), then a new streamId will be allocated, to support unused anchor streams that act as parent for other streams.

Specified by:

priority in interface Session

Parameters:

frame - the PRIORITY frame to send

callback - the callback that gets notified when the frame has been sent

Returns:

the new stream id generated by the PRIORITY frame, or the stream id that it is already referencing

push

public void push(IStream stream,
 Promise<Stream> promise,
 PushPromiseFrame frame,
 Stream.Listener listener)

Description copied from interface: ISession

Enqueues the given PUSH_PROMISE frame to be written to the connection.

Differently from ISession.frames(IStream, List, Callback), this method generates atomically the stream id for the pushed stream.

Specified by:

push in interface ISession

Parameters:

stream - the stream associated to the pushed stream

promise - the promise that gets notified of the pushed stream creation

frame - the PUSH_PROMISE frame to enqueue

listener - the listener that gets notified of pushed stream events

settings

public void settings(SettingsFrame frame,
 Callback callback)

Description copied from interface: Session

Sends the given SETTINGS frame to configure the session.

Specified by:

settings in interface Session

Parameters:

frame - the SETTINGS frame to send

callback - the callback that gets notified when the frame has been sent

ping

public void ping(PingFrame frame,
 Callback callback)

Description copied from interface: Session

Sends the given PING frame.

PING frames may be used to test the connection integrity and to measure round-trip time.

Specified by:

ping in interface Session

Parameters:

frame - the PING frame to send

callback - the callback that gets notified when the frame has been sent

close

public boolean close(int error,
 String reason,
 Callback callback)

Invoked internally and by applications to send a GO_AWAY frame to the other peer.

Specified by:

close in interface Session

Parameters:

error - the error code

reason - the reason

callback - the callback to invoke when the operation is complete

Returns:

true if the frame is being sent, false if the session was already closed

See Also:

• onGoAway(GoAwayFrame)
• onShutdown()
• onIdleTimeout()

shutdown

public CompletableFuture<Void> shutdown()

Description copied from interface: ISession

Gracefully closes the session, returning a CompletableFuture that is completed when all the streams currently being processed are completed.

Implementation is idempotent, i.e. calling this method a second time or concurrently results in a no-operation.

Specified by:

shutdown in interface ISession

Returns:

a CompletableFuture that is completed when all the streams are completed

goAway

public boolean goAway(GoAwayFrame frame,
 Callback callback)

isClosed

public boolean isClosed()

Specified by:

isClosed in interface Session

Returns:

whether the session is not open

getCloseState

public CloseState getCloseState()

frames

public void frames(IStream stream,
 List<? extends Frame> frames,
 Callback callback)

Description copied from interface: ISession

Enqueues the given frames to be written to the connection.

Specified by:

frames in interface ISession

Parameters:

stream - the stream the frames belong to

frames - the frames to enqueue

callback - the callback that gets notified when the frames have been sent

data

public void data(IStream stream,
 Callback callback,
 DataFrame frame)

Description copied from interface: ISession

Enqueues the given DATA frame to be written to the connection.

Specified by:

data in interface ISession

Parameters:

stream - the stream the data frame belongs to

callback - the callback that gets notified when the frame has been sent

frame - the DATA frame to send

createLocalStream

protected IStream createLocalStream(int streamId,
 MetaData.Request request,
 Consumer<Throwable> failFn)

createRemoteStream

protected IStream createRemoteStream(int streamId,
 MetaData.Request request)

removeStream

public boolean removeStream(IStream stream)

Description copied from interface: ISession

Removes the given stream.

Specified by:

removeStream in interface ISession

Parameters:

stream - the stream to remove

Returns:

whether the stream was removed

getStreams

public Collection<Stream> getStreams()

Specified by:

getStreams in interface Session

Returns:

a snapshot of all the streams currently belonging to this session

getStreamCount

@ManagedAttribute("The number of active streams")
public int getStreamCount()

getStream

public IStream getStream(int streamId)

Description copied from interface: Session

Retrieves the stream with the given streamId.

Specified by:

getStream in interface ISession

Specified by:

getStream in interface Session

Parameters:

streamId - the stream id of the stream looked for

Returns:

the stream with the given id, or null if no such stream exist

getLocalAddress

public InetSocketAddress getLocalAddress()

Specified by:

getLocalAddress in interface Session

Returns:

the local network address this session is bound to, or null if this session is not bound to a network address

getLocalSocketAddress

public SocketAddress getLocalSocketAddress()

Specified by:

getLocalSocketAddress in interface Session

Returns:

the local network address this session is bound to, or null if this session is not bound to a network address

getRemoteAddress

public InetSocketAddress getRemoteAddress()

Specified by:

getRemoteAddress in interface Session

Returns:

the remote network address this session is connected to, or null if this session is not connected to a network address

getRemoteSocketAddress

public SocketAddress getRemoteSocketAddress()

Specified by:

getRemoteSocketAddress in interface Session

Returns:

the remote network address this session is connected to, or null if this session is not connected to a network address

getSendWindow

@ManagedAttribute(value="The flow control send window",
                  readonly=true)
public int getSendWindow()

getRecvWindow

@ManagedAttribute(value="The flow control receive window",
                  readonly=true)
public int getRecvWindow()

updateSendWindow

public int updateSendWindow(int delta)

Description copied from interface: ISession

Updates the session send window by the given delta.

Specified by:

updateSendWindow in interface ISession

Parameters:

delta - the delta value (positive or negative) to add to the session send window

Returns:

the previous value of the session send window

updateRecvWindow

public int updateRecvWindow(int delta)

Description copied from interface: ISession

Updates the session receive window by the given delta.

Specified by:

updateRecvWindow in interface ISession

Parameters:

delta - the delta value (positive or negative) to add to the session receive window

Returns:

the previous value of the session receive window

isPushEnabled

@ManagedAttribute(value="Whether HTTP/2 push is enabled",
                  readonly=true)
public boolean isPushEnabled()

Specified by:

isPushEnabled in interface ISession

Returns:

whether the push functionality is enabled

isConnectProtocolEnabled

@ManagedAttribute(value="Whether CONNECT requests supports a protocol",
                  readonly=true)
public boolean isConnectProtocolEnabled()

setConnectProtocolEnabled

public void setConnectProtocolEnabled(boolean connectProtocolEnabled)

onShutdown

public void onShutdown()

This method is called when the TCP FIN is received from the remote peer.

Specified by:

onShutdown in interface ISession

See Also:

• onGoAway(GoAwayFrame)
• close(int, String, Callback)
• onIdleTimeout()

onIdleTimeout

public boolean onIdleTimeout()

This method is invoked when the idle timeout expires.

Specified by:

onIdleTimeout in interface ISession

Returns:

true if the session should be closed, false otherwise

See Also:

• onGoAway(GoAwayFrame)
• close(int, String, Callback)
• onShutdown()

onFrame

public void onFrame(Frame frame)

Description copied from interface: ISession

Callback method invoked during an HTTP/1.1 to HTTP/2 upgrade requests to process the given synthetic frame.

Specified by:

onFrame in interface ISession

Parameters:

frame - the synthetic frame to process

onStreamOpened

protected final void onStreamOpened(IStream stream)

onFlushed

public void onFlushed(long bytes)
               throws IOException

Description copied from interface: ISession

Callback method invoked when bytes are flushed to the network.

Specified by:

onFlushed in interface ISession

Parameters:

bytes - the number of bytes flushed to the network

Throws:

IOException - if the flush should fail

disconnect

public void disconnect()

isDisconnected

public boolean isDisconnected()

getLastRemoteStreamId

protected int getLastRemoteStreamId()

updateLastRemoteStreamId

protected void updateLastRemoteStreamId(int streamId)

notifyNewStream

protected Stream.Listener notifyNewStream(Stream stream,
 HeadersFrame frame)

notifySettings

protected void notifySettings(Session session,
 SettingsFrame frame)

notifyPing

protected void notifyPing(Session session,
 PingFrame frame)

notifyReset

protected void notifyReset(Session session,
 ResetFrame frame)

notifyGoAway

protected void notifyGoAway(Session session,
 GoAwayFrame frame)

notifyClose

protected void notifyClose(Session session,
 GoAwayFrame frame,
 Callback callback)

notifyIdleTimeout

protected boolean notifyIdleTimeout(Session session)

notifyFailure

protected void notifyFailure(Session session,
 Throwable failure,
 Callback callback)

notifyHeaders

protected void notifyHeaders(IStream stream,
 HeadersFrame frame)

isClientStream

protected static boolean isClientStream(int streamId)

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

toString

public String toString()

Overrides:

toString in class AbstractLifeCycle