SessionSPI

The SPI interface for implementing a HTTP/2 session. This class :{@link Session} by adding the methods required to implement the HTTP/2 session functionalities.

interface SessionSPI : Session {

StreamSPI getStream(int streamId);

void removeStream(StreamSPI stream);

void frames(StreamSPI stream, Callback callback, Frame frame, Frame[] frames);

void push(StreamSPI stream, Promise!Stream promise, PushPromiseFrame frame, Stream.Listener listener);

void data(StreamSPI stream, Callback callback, DataFrame frame);

int updateSendWindow(int delta);

int updateRecvWindow(int delta);

void onWindowUpdate(StreamSPI stream, WindowUpdateFrame frame);

bool isPushEnabled();

void onShutdown();

bool onIdleTimeout();

void onFrame(Frame frame);

long getBytesWritten();

}

Members

Functions

data void data(StreamSPI stream, Callback callback, DataFrame frame): Enqueues the given DATA frame to be written to the connection.
frames void frames(StreamSPI stream, Callback callback, Frame frame, Frame[] frames): Enqueues the given frames to be written to the connection.
getBytesWritten long getBytesWritten(): @return the number of bytes written by this session
getStream StreamSPI getStream(int streamId): Undocumented in source.
isPushEnabled bool isPushEnabled(): @return whether the push functionality is enabled
onFrame void onFrame(Frame frame): Callback method invoked during an HTTP/1.1 to HTTP/2 upgrade requests to process the given synthetic frame.
onIdleTimeout bool onIdleTimeout(): Callback invoked when the idle timeout expires.
onShutdown void onShutdown(): Callback invoked when the connection reads -1.
onWindowUpdate void onWindowUpdate(StreamSPI stream, WindowUpdateFrame frame): Callback method invoked when a WINDOW_UPDATE frame has been received.
push void push(StreamSPI stream, Promise!Stream promise, PushPromiseFrame frame, Stream.Listener listener): Enqueues the given PUSH_PROMISE frame to be written to the connection. Differently from {@link #frames(StreamSPI, Callback, Frame, Frame...)}, this method generates atomically the stream id for the pushed stream.
removeStream void removeStream(StreamSPI stream): Removes the given {@code stream}.
updateRecvWindow int updateRecvWindow(int delta): Updates the session receive window by the given {@code delta}.
updateSendWindow int updateSendWindow(int delta): Updates the session send window by the given {@code delta}.

Inherited Members

From Session

newStream void newStream(HeadersFrame frame, Promise!Stream promise, Stream.Listener listener): Sends the given HEADERS {@code frame} to create a new {@link Stream}.
priority int priority(PriorityFrame frame, Callback callback): Sends the given PRIORITY {@code frame}. If the {@code frame} references a {@code streamId} that does not exist (for example {@code 0}), then a new {@code streamId} will be allocated, to support unused anchor streams that act as parent for other streams.
settings void settings(SettingsFrame frame, Callback callback): Sends the given SETTINGS {@code frame} to configure the session.
ping void ping(PingFrame frame, Callback callback): Sends the given PING {@code frame}. PING frames may be used to test the connection integrity and to measure round-trip time.
close bool close(int error, string payload, Callback callback): Closes the session by sending a GOAWAY frame with the given error code and payload. The GOAWAY frame is sent only once; subsequent or concurrent attempts to close the session will have no effect.
isClosed bool isClosed(): @return whether the session is not open
getStreams Stream[] getStreams(): @return a snapshot of all the streams currently belonging to this session
getStream Stream getStream(int streamId): Retrieves the stream with the given {@code streamId}.
toString string toString(): Undocumented in source.
Listener interface Listener: A {@link Listener} is the passive counterpart of a {@link Session} and receives events happening on a HTTP/2 connection.

SessionSPI

Members

Functions

Inherited Members

From Session

Meta

Source