Package org.eclipse.jetty.http2.api

Interface Stream.Listener

All Known Implementing Classes:

HTTP2ServerConnectionFactory.HTTPServerSessionListener, HttpReceiverOverHTTP2, Stream.Listener.Adapter

Enclosing interface:

Stream

public static interface Stream.Listener

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

See Also:

Stream

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
default void	onClosed(Stream stream)	Callback method invoked after the stream has been closed.
void	onData(Stream stream, DataFrame frame, Callback callback)	Callback method invoked when a DATA frame has been received.
default void	onFailure(Stream stream, int error, java.lang.String reason, java.lang.Throwable failure, Callback callback)	Callback method invoked when the stream failed.
default void	onFailure(Stream stream, int error, java.lang.String reason, Callback callback)	Deprecated. use onFailure(Stream, int, String, Throwable, Callback) instead
void	onHeaders(Stream stream, HeadersFrame frame)	Callback method invoked when a HEADERS frame representing the HTTP response has been received.
default boolean	onIdleTimeout(Stream stream, java.lang.Throwable x)	Callback method invoked when the stream exceeds its idle timeout.
default void	onNewStream(Stream stream)	Callback method invoked when a stream is created locally by Session.newStream(HeadersFrame, Promise, Listener).
Stream.Listener	onPush(Stream stream, PushPromiseFrame frame)	Callback method invoked when a PUSH_PROMISE frame has been received.
default void	onReset(Stream stream, ResetFrame frame)	Callback method invoked when a RST_STREAM frame has been received for this stream.
default void	onReset(Stream stream, ResetFrame frame, Callback callback)	Callback method invoked when a RST_STREAM frame has been received for this stream.
default void	onTimeout(Stream stream, java.lang.Throwable x)	Deprecated. use onIdleTimeout(Stream, Throwable) instead

Method Detail

onNewStream

default void onNewStream(Stream stream)

Callback method invoked when a stream is created locally by Session.newStream(HeadersFrame, Promise, Listener).

Parameters:

stream - the newly created stream

onHeaders

void onHeaders(Stream stream,
               HeadersFrame frame)

Callback method invoked when a HEADERS frame representing the HTTP response has been received.

Parameters:

stream - the stream

frame - the HEADERS frame received

onPush

Stream.Listener onPush(Stream stream,
                       PushPromiseFrame frame)

Callback method invoked when a PUSH_PROMISE frame has been received.

Parameters:

stream - the stream

frame - the PUSH_PROMISE frame received

Returns:

a Stream.Listener that will be notified of pushed stream events

onData

void onData(Stream stream,
            DataFrame frame,
            Callback callback)

Callback method invoked when a DATA frame has been received.

Parameters:

stream - the stream

frame - the DATA frame received

callback - the callback to complete when the bytes of the DATA frame have been consumed

onReset

default void onReset(Stream stream,
                     ResetFrame frame,
                     Callback callback)

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

Parameters:

stream - the stream

frame - the RST_FRAME received

callback - the callback to complete when the reset has been handled

onReset

default void onReset(Stream stream,
                     ResetFrame frame)

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

Parameters:

stream - the stream

frame - the RST_FRAME received

See Also:

Session.Listener.onReset(Session, ResetFrame)

onTimeout

@Deprecated
default void onTimeout(Stream stream,
                       java.lang.Throwable x)

Deprecated.

use onIdleTimeout(Stream, Throwable) instead

Callback method invoked when the stream exceeds its idle timeout.

Parameters:

stream - the stream

x - the timeout failure

See Also:

Stream.getIdleTimeout()

onIdleTimeout

default boolean onIdleTimeout(Stream stream,
                              java.lang.Throwable x)

Callback method invoked when the stream exceeds its idle timeout.

Parameters:

stream - the stream

x - the timeout failure

Returns:

true to reset the stream, false to ignore the idle timeout

See Also:

Stream.getIdleTimeout()

onFailure

default void onFailure(Stream stream,
                       int error,
                       java.lang.String reason,
                       java.lang.Throwable failure,
                       Callback callback)

Callback method invoked when the stream failed.

Parameters:

stream - the stream

error - the error code

reason - the error reason, or null

failure - the failure

callback - the callback to complete when the failure has been handled

onFailure

@Deprecated
default void onFailure(Stream stream,
                       int error,
                       java.lang.String reason,
                       Callback callback)

Deprecated.

use onFailure(Stream, int, String, Throwable, Callback) instead

Callback method invoked when the stream failed.

Parameters:

stream - the stream

error - the error code

reason - the error reason, or null

callback - the callback to complete when the failure has been handled

onClosed

default void onClosed(Stream stream)

Callback method invoked after the stream has been closed.

Parameters:

stream - the stream