Package org.eclipse.jetty.http2.api

Interface Session.Listener

All Known Subinterfaces:

ServerSessionListener

All Known Implementing Classes:

HTTP2ServerConnectionFactory.HTTPServerSessionListener, ServerSessionListener.Adapter, Session.Listener.Adapter

Enclosing interface:

Session

public static interface Session.Listener

A Session.Listener is the passive counterpart of a Session and receives events happening on an HTTP/2 connection.

See Also:

• Session

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Session.Listener.Adapter	Empty implementation of Stream.Listener.

Method Summary

Modifier and Type	Method	Description
void	onClose(Session session, GoAwayFrame frame)
default void	onClose(Session session, GoAwayFrame frame, Callback callback)	Callback method invoked when a GOAWAY frame caused the session to be closed.
void	onFailure(Session session, Throwable failure)
default void	onFailure(Session session, Throwable failure, Callback callback)	Callback method invoked when a failure has been detected for this session.
default void	onGoAway(Session session, GoAwayFrame frame)	Callback method invoked when a GOAWAY frame has been received.
boolean	onIdleTimeout(Session session)	Callback method invoked when the idle timeout expired.
Stream.Listener	onNewStream(Stream stream, HeadersFrame frame)	Callback method invoked when a new stream is being created upon receiving a HEADERS frame representing an HTTP request.
void	onPing(Session session, PingFrame frame)	Callback method invoked when a PING frame has been received.
Map<Integer,Integer>	onPreface(Session session)	Callback method invoked:
void	onReset(Session session, ResetFrame frame)	Callback method invoked when a RST_STREAM frame has been received for an unknown stream.
void	onSettings(Session session, SettingsFrame frame)	Callback method invoked when a SETTINGS frame has been received.

Method Details

onPreface

Map<Integer,Integer> onPreface(Session session)

Callback method invoked:

• for clients, just before the preface is sent, to gather the SETTINGS configuration options the client wants to send to the server;
• for servers, just after having received the preface, to gather the SETTINGS configuration options the server wants to send to the client.

Parameters:

session - the session

Returns:

a (possibly empty or null) map containing SETTINGS configuration options to send.

onNewStream

Stream.Listener onNewStream(Stream stream,
 HeadersFrame frame)

Callback method invoked when a new stream is being created upon receiving a HEADERS frame representing an HTTP request.

Applications should implement this method to process HTTP requests, typically providing an HTTP response via Stream.headers(HeadersFrame, Callback).

Applications can detect whether request DATA frames will be arriving by testing HeadersFrame.isEndStream(). If the application is interested in processing the DATA frames, it must return a Stream.Listener implementation that overrides Stream.Listener.onData(Stream, DataFrame, Callback).

Parameters:

stream - the newly created stream

frame - the HEADERS frame received

Returns:

a Stream.Listener that will be notified of stream events

onSettings

void onSettings(Session session,
 SettingsFrame frame)

Callback method invoked when a SETTINGS frame has been received.

Parameters:

session - the session

frame - the SETTINGS frame received

onPing

void onPing(Session session,
 PingFrame frame)

Callback method invoked when a PING frame has been received.

Parameters:

session - the session

frame - the PING frame received

onReset

void onReset(Session session,
 ResetFrame frame)

Callback method invoked when a RST_STREAM frame has been received for an unknown stream.

Parameters:

session - the session

frame - the RST_STREAM frame received

See Also:

• Stream.Listener.onReset(Stream, ResetFrame)

onGoAway

default void onGoAway(Session session,
 GoAwayFrame frame)

Callback method invoked when a GOAWAY frame has been received.

Parameters:

session - the session

frame - the GOAWAY frame received

onClose

default void onClose(Session session,
 GoAwayFrame frame,
 Callback callback)

Callback method invoked when a GOAWAY frame caused the session to be closed.

Parameters:

session - the session

frame - the GOAWAY frame that caused the session to be closed

callback - the callback to notify of the GOAWAY processing

onClose

void onClose(Session session,
 GoAwayFrame frame)

onIdleTimeout

boolean onIdleTimeout(Session session)

Callback method invoked when the idle timeout expired.

Parameters:

session - the session

Returns:

whether the session should be closed

onFailure

default void onFailure(Session session,
 Throwable failure,
 Callback callback)

Callback method invoked when a failure has been detected for this session.

Parameters:

session - the session

failure - the failure

callback - the callback to notify of failure processing

onFailure

void onFailure(Session session,
 Throwable failure)