Package org.eclipse.jetty.http2.api

Interface Session.Listener

All Known Subinterfaces:
ServerSessionListener
All Known Implementing Classes:
HTTP2ServerConnectionFactory.HTTPServerSessionListener, HTTPSessionListenerPromise
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:

  • Method Details

    • onPreface

      default 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

      default 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 demand for DATA frames using Stream.demand() and then return either a Stream.Listener implementation that overrides Stream.Listener.onDataAvailable(Stream) where applications can read from the Stream via Stream.readData(), or Stream.Listener.AUTO_DISCARD that automatically reads and discards DATA frames. Returning null is possible but discouraged, and has the same effect of demanding and discarding the DATA frames.

      Parameters:
      stream - the newly created stream
      frame - the HEADERS frame received
      Returns:
      a Stream.Listener that will be notified of stream events

    • onSettings

      default 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

      default 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

      default 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:

    • 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

    • onIdleTimeout

      default 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