org.eclipse.jetty.http2

Class HTTP2Session

java.lang.Object

org.eclipse.jetty.http2.HTTP2Session

All Implemented Interfaces:

Session, ISession, Parser.Listener

public abstract class HTTP2Session
extends Object
implements ISession, Parser.Listener

Nested Class Summary

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

Session.Listener

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

Parser.Listener.Adapter

Constructor Summary

Constructors

Constructor and Description
HTTP2Session(Scheduler scheduler, EndPoint endPoint, Generator generator, Session.Listener listener, FlowControl flowControl, int initialStreamId)

Method Summary

Methods

Modifier and Type	Method and Description
void	close(int error, String reason, Callback callback) Invoked internally and by applications to send a GO_AWAY frame to the other peer.
void	control(IStream stream, Callback callback, Frame frame, Frame... frames)
protected IStream	createLocalStream(int streamId, Promise<Stream> promise)
protected IStream	createRemoteStream(int streamId)
void	data(IStream stream, Callback callback, DataFrame frame)
void	disconnect()
EndPoint	getEndPoint()
FlowControl	getFlowControl()
Generator	getGenerator()
int	getMaxLocalStreams()
int	getMaxRemoteStreams()
protected int	getRecvWindow()
protected int	getSendWindow()
IStream	getStream(int streamId)
long	getStreamIdleTimeout()
Collection<Stream>	getStreams()
boolean	isClosed()
boolean	isDisconnected()
boolean	isPushEnabled()
void	newStream(HeadersFrame frame, Promise<Stream> promise, Stream.Listener listener)
protected IStream	newStream(int streamId)
protected void	notifyClose(Session session, GoAwayFrame frame)
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)
boolean	onData(DataFrame frame)
boolean	onGoAway(GoAwayFrame frame) This method is called when receiving a GO_AWAY from the other peer.
abstract boolean	onHeaders(HeadersFrame frame)
void	onIdleTimeout() This method is invoked when the idle timeout triggers.
boolean	onPing(PingFrame frame)
boolean	onPriority(PriorityFrame frame)
boolean	onReset(ResetFrame frame)
boolean	onSettings(SettingsFrame frame)
void	onShutdown() A typical close by a remote peer involves a GO_AWAY frame followed by TCP FIN.
void	onWindowUpdate(IStream stream, WindowUpdateFrame frame)
boolean	onWindowUpdate(WindowUpdateFrame frame)
void	ping(PingFrame frame, Callback callback)
void	push(IStream stream, Promise<Stream> promise, PushPromiseFrame frame)
protected void	removeStream(IStream stream, boolean local)
protected void	reset(ResetFrame frame, Callback callback)
void	setMaxLocalStreams(int maxLocalStreams)
void	setMaxRemoteStreams(int maxRemoteStreams)
void	setStreamIdleTimeout(long streamIdleTimeout)
void	settings(SettingsFrame frame, Callback callback)
String	toString()
int	updateRecvWindow(int delta)
int	updateSendWindow(int delta)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.http2.parser.Parser.Listener

onPushPromise

Constructor Detail

HTTP2Session

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

Method Detail

getFlowControl

public FlowControl getFlowControl()

getMaxLocalStreams

public int getMaxLocalStreams()

setMaxLocalStreams

public void setMaxLocalStreams(int maxLocalStreams)

getMaxRemoteStreams

public int getMaxRemoteStreams()

setMaxRemoteStreams

public void setMaxRemoteStreams(int maxRemoteStreams)

getStreamIdleTimeout

public long getStreamIdleTimeout()

setStreamIdleTimeout

public void setStreamIdleTimeout(long streamIdleTimeout)

getEndPoint

public EndPoint getEndPoint()

getGenerator

public Generator getGenerator()

onData

public boolean onData(DataFrame frame)

Specified by:

onData in interface Parser.Listener

onHeaders

public abstract boolean onHeaders(HeadersFrame frame)

Specified by:

onHeaders in interface Parser.Listener

onPriority

public boolean onPriority(PriorityFrame frame)

Specified by:

onPriority in interface Parser.Listener

onReset

public boolean onReset(ResetFrame frame)

Specified by:

onReset in interface Parser.Listener

onSettings

public boolean onSettings(SettingsFrame frame)

Specified by:

onSettings in interface Parser.Listener

onPing

public boolean onPing(PingFrame frame)

Specified by:

onPing in interface Parser.Listener

onGoAway

public boolean onGoAway(GoAwayFrame frame)

This method is called when receiving a GO_AWAY from the other peer. We check the close state to act appropriately: * NOT_CLOSED: we move to REMOTELY_CLOSED and queue a disconnect, so that the content of the queue is written, and then the connection closed. We notify the application after being terminated. See HTTP2Session.ControlEntry.succeeded() * In all other cases, we do nothing since other methods are already performing their actions.

Specified by:

onGoAway in interface Parser.Listener

Parameters:

frame - the GO_AWAY frame that has been received.

Returns:

whether the parsing will be resumed asynchronously

See Also:

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

onWindowUpdate

public boolean onWindowUpdate(WindowUpdateFrame frame)

Specified by:

onWindowUpdate in interface Parser.Listener

onConnectionFailure

public void onConnectionFailure(int error,
                       String reason)

Specified by:

onConnectionFailure in interface Parser.Listener

newStream

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

Specified by:

newStream in interface Session

push

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

Specified by:

push in interface ISession

settings

public void settings(SettingsFrame frame,
            Callback callback)

Specified by:

settings in interface Session

ping

public void ping(PingFrame frame,
        Callback callback)

Specified by:

ping in interface Session

reset

protected void reset(ResetFrame frame,
         Callback callback)

close

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

Invoked internally and by applications to send a GO_AWAY frame to the other peer. We check the close state to act appropriately: * NOT_CLOSED: we move to LOCALLY_CLOSED and queue a GO_AWAY. When the GO_AWAY has been written, it will only cause the output to be shut down (not the connection closed), so that the application can still read frames arriving from the other peer. Ideally the other peer will notice the GO_AWAY and close the connection. When that happen, we close the connection from onShutdown(). Otherwise, the idle timeout mechanism will close the connection, see onIdleTimeout(). * In all other cases, we do nothing since other methods are already performing their actions.

Specified by:

close in interface Session

Parameters:

error - the error code

reason - the reason

callback - the callback to invoke when the operation is complete

See Also:

onGoAway(GoAwayFrame), onShutdown(), onIdleTimeout()

isClosed

public boolean isClosed()

Specified by:

isClosed in interface Session

control

public void control(IStream stream,
           Callback callback,
           Frame frame,
           Frame... frames)

Specified by:

control in interface ISession

data

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

Specified by:

data in interface ISession

createLocalStream

protected IStream createLocalStream(int streamId,
                        Promise<Stream> promise)

createRemoteStream

protected IStream createRemoteStream(int streamId)

newStream

protected IStream newStream(int streamId)

removeStream

protected void removeStream(IStream stream,
                boolean local)

getStreams

public Collection<Stream> getStreams()

Specified by:

getStreams in interface Session

getStream

public IStream getStream(int streamId)

Specified by:

getStream in interface Session

Specified by:

getStream in interface ISession

getSendWindow

protected int getSendWindow()

getRecvWindow

protected int getRecvWindow()

updateSendWindow

public int updateSendWindow(int delta)

Specified by:

updateSendWindow in interface ISession

updateRecvWindow

public int updateRecvWindow(int delta)

Specified by:

updateRecvWindow in interface ISession

onWindowUpdate

public void onWindowUpdate(IStream stream,
                  WindowUpdateFrame frame)

Specified by:

onWindowUpdate in interface ISession

isPushEnabled

public boolean isPushEnabled()

Specified by:

isPushEnabled in interface ISession

onShutdown

public void onShutdown()

A typical close by a remote peer involves a GO_AWAY frame followed by TCP FIN. This method is invoked when the TCP FIN is received, or when an exception is thrown while reading, and we check the close state to act appropriately: * NOT_CLOSED: means that the remote peer did not send a GO_AWAY (abrupt close) or there was an exception while reading, and therefore we terminate. * LOCALLY_CLOSED: we have sent the GO_AWAY to the remote peer, which received it and closed the connection; we queue a disconnect to close the connection on the local side. The GO_AWAY just shutdown the output, so we need this step to make sure the connection is closed. See close(int, String, Callback). * REMOTELY_CLOSED: we received the GO_AWAY, and the TCP FIN afterwards, so we do nothing since the handling of the GO_AWAY will take care of closing the connection. See onGoAway(GoAwayFrame).

Specified by:

onShutdown in interface ISession

See Also:

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

onIdleTimeout

public void onIdleTimeout()

This method is invoked when the idle timeout triggers. We check the close state to act appropriately: * NOT_CLOSED: it's a real idle timeout, we just initiate a close, see close(int, String, Callback). * LOCALLY_CLOSED: we have sent a GO_AWAY and only shutdown the output, but the other peer did not close the connection so we never received the TCP FIN, and therefore we terminate. * REMOTELY_CLOSED: the other peer sent us a GO_AWAY, we should have queued a disconnect, but for some reason it was not processed (for example, queue was stuck because of TCP congestion), therefore we terminate. See onGoAway(GoAwayFrame).

Specified by:

onIdleTimeout in interface ISession

See Also:

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

disconnect

public void disconnect()

isDisconnected

public boolean isDisconnected()

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)

notifyClose

protected void notifyClose(Session session,
               GoAwayFrame frame)

toString

public String toString()

Overrides:

toString in class Object