org.eclipse.jetty.http2.api

Class Session.Listener.Adapter

java.lang.Object

org.eclipse.jetty.http2.api.Session.Listener.Adapter

All Implemented Interfaces:

Session.Listener

Direct Known Subclasses:

ServerSessionListener.Adapter

Enclosing interface:

Session.Listener

public static class Session.Listener.Adapter
extends Object
implements Session.Listener

Empty implementation of Stream.Listener.

Nested Class Summary

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

Session.Listener.Adapter

Constructor Summary

Constructors

Constructor and Description
Adapter()

Method Summary

Modifier and Type	Method and Description
void	onClose(Session session, GoAwayFrame frame) Callback method invoked when a GOAWAY frame has been received.
void	onFailure(Session session, Throwable failure) Callback method invoked when a failure has been detected for this session.
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 a 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

Adapter

public Adapter()

Method Detail

onPreface

public Map<Integer,Integer> onPreface(Session session)

Description copied from interface: Session.Listener

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.

Specified by:

onPreface in interface Session.Listener

Parameters:

session - the session

Returns:

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

onNewStream

public Stream.Listener onNewStream(Stream stream,
                                   HeadersFrame frame)

Description copied from interface: Session.Listener

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

Applications should implement this method to process HTTP requests, typically providing a 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).

Specified by:

onNewStream in interface Session.Listener

Parameters:

stream - the newly created stream

frame - the HEADERS frame received

Returns:

a Stream.Listener that will be notified of stream events

onSettings

public void onSettings(Session session,
                       SettingsFrame frame)

Description copied from interface: Session.Listener

Callback method invoked when a SETTINGS frame has been received.

Specified by:

onSettings in interface Session.Listener

Parameters:

session - the session

frame - the SETTINGS frame received

onPing

public void onPing(Session session,
                   PingFrame frame)

Description copied from interface: Session.Listener

Callback method invoked when a PING frame has been received.

Specified by:

onPing in interface Session.Listener

Parameters:

session - the session

frame - the PING frame received

onReset

public void onReset(Session session,
                    ResetFrame frame)

Description copied from interface: Session.Listener

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

Specified by:

onReset in interface Session.Listener

Parameters:

session - the session

frame - the RST_STREAM frame received

See Also:

Stream.Listener.onReset(Stream, ResetFrame)

onClose

public void onClose(Session session,
                    GoAwayFrame frame)

Description copied from interface: Session.Listener

Callback method invoked when a GOAWAY frame has been received.

Specified by:

onClose in interface Session.Listener

Parameters:

session - the session

frame - the GOAWAY frame received

onIdleTimeout

public boolean onIdleTimeout(Session session)

Description copied from interface: Session.Listener

Callback method invoked when the idle timeout expired.

Specified by:

onIdleTimeout in interface Session.Listener

Parameters:

session - the session

Returns:

whether the session should be closed

onFailure

public void onFailure(Session session,
                      Throwable failure)

Description copied from interface: Session.Listener

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

Specified by:

onFailure in interface Session.Listener

Parameters:

session - the session

failure - the failure