Session

A {@link Session} represents the client-side endpoint of a HTTP/2 connection to a single origin server. Once a {@link Session} has been obtained, it can be used to open HTTP/2 streams: <pre> Session session = ...; HeadersFrame frame = ...; Promise<Stream> promise = ... session.newStream(frame, promise, new Stream.Listener.Adapter() { void onHeaders(Stream stream, HeadersFrame frame) { // Reply received } }); </pre> A {@link Session} is the active part of the endpoint, and by calling its API applications can generate events on the connection; conversely {@link Session.Listener} is the passive part of the endpoint, and has callbacks that are invoked when events happen on the connection.

@see Session.Listener

interface Session {

void newStream(HeadersFrame frame, Promise!Stream promise, Stream.Listener listener);

int priority(PriorityFrame frame, Callback callback);

void settings(SettingsFrame frame, Callback callback);

void ping(PingFrame frame, Callback callback);

bool close(int error, string payload, Callback callback);

bool isClosed();

Stream[] getStreams();

Stream getStream(int streamId);

string toString();

interface Listener;

}

Members

Functions

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.
getStream Stream getStream(int streamId): Retrieves the stream with the given {@code streamId}.
getStreams Stream[] getStreams(): @return a snapshot of all the streams currently belonging to this session
isClosed bool isClosed(): @return whether the session is not open
newStream void newStream(HeadersFrame frame, Promise!Stream promise, Stream.Listener listener): Sends the given HEADERS {@code frame} to create a new {@link Stream}.
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.
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.
toString string toString(): Undocumented in source.

Interfaces

Listener interface Listener: A {@link Listener} is the passive counterpart of a {@link Session} and receives events happening on a HTTP/2 connection.

Session

Members

Functions

Interfaces

Meta

Source