Overrides default org.eclipse.jetty.http2.api.Session.Listener.onClose.

Doc from org.eclipse.jetty.http2.api.Session.Listener.onClose.

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

Parameters

session:Session

the session

frame:GoAwayFrame

the GOAWAY frame that caused the session to be closed

callback:Callback

the callback to notify of the GOAWAY processing

Annotations

@Override

Overrides default org.eclipse.jetty.http2.api.Stream.Listener.onDataAvailable.

Doc from org.eclipse.jetty.http2.api.Stream.Listener.onDataAvailable.

Callback method invoked if the application has expressed demand for DATA frames, and if there may be content available.

Applications that wish to handle DATA frames should call Stream#demand() for this method to be invoked when the data is available.

Server applications should typically demand from onNewStream(Stream) (upon receiving an HTTP request), while client applications should typically demand from onHeaders(Stream, HeadersFrame) (upon receiving an HTTP response).

Just prior calling this method, the outstanding demand is cancelled; applications that implement this method should read content calling Stream#readData(), and call Stream#demand() to signal to the implementation to call again this method when there may be more content available.

Only one thread at a time invokes this method, although it may not be the same thread across different invocations.

It is always guaranteed that invoking Stream#demand() from within this method will not cause a StackOverflowError.

Typical usage:

class MyStreamListener implements Stream.Listener
{
    @Override
    public void onDataAvailable(Stream stream)
    {
        // Read a chunk of the content.
        Stream.Data data = stream.readData();
        if (data == null)
        {
            // No data available now, demand to be called back.
            stream.demand();
        }
        else
        {
            // Process the content.
            process(data.frame().getByteBuffer());
            // Notify that the content has been consumed.
            data.release();
            if (!data.frame().isEndStream())
            {
                // Demand to be called back.
                stream.demand();
            }
        }
    }
}

Parameters

stream:Stream

the stream

Annotations

@Override

Overrides default org.eclipse.jetty.http2.api.Session.Listener.onFailure.

Doc from org.eclipse.jetty.http2.api.Session.Listener.onFailure.

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

Parameters

session:Session

the session

failure:Throwable

the failure

callback:Callback

the callback to notify of failure processing

Annotations

@Override

Overrides default org.eclipse.jetty.http2.api.Stream.Listener.onFailure.

Doc from org.eclipse.jetty.http2.api.Stream.Listener.onFailure.

Callback method invoked when the stream failed.

Parameters

stream:Stream

the stream

error:int

the error code

reason:String

the error reason, or null

failure:Throwable

the failure

callback:Callback

the callback to complete when the failure has been handled

Annotations

@Override

Overrides default org.eclipse.jetty.http2.api.Stream.Listener.onHeaders.

Doc from org.eclipse.jetty.http2.api.Stream.Listener.onHeaders.

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

Parameters

stream:Stream

the stream

frame:HeadersFrame

the HEADERS frame received

Annotations

@Override

Overrides default org.eclipse.jetty.http2.api.Session.Listener.onIdleTimeout.

Doc from org.eclipse.jetty.http2.api.Session.Listener.onIdleTimeout.

Callback method invoked when the idle timeout expired.

Parameters

session:Session

the session

Returns:boolean

whether the session should be closed

Annotations

@Override

Overrides default org.eclipse.jetty.http2.api.Stream.Listener.onIdleTimeout.

Doc from org.eclipse.jetty.http2.api.Stream.Listener.onIdleTimeout.

Callback method invoked when the stream exceeds its idle timeout.

Parameters

stream:Stream

the stream

x:TimeoutException

the timeout failure

promise:Promise<Boolean>

the promise to complete

Annotations

@Override

Overrides default org.eclipse.jetty.http2.api.Session.Listener.onNewStream.

Doc from org.eclipse.jetty.http2.api.Session.Listener.onNewStream.

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

the newly created stream

frame:HeadersFrame

the HEADERS frame received

Returns:Stream.Listener

a Stream.Listener that will be notified of stream events

Annotations

@Override

Overrides default org.eclipse.jetty.http2.api.Session.Listener.onPreface.

Doc from org.eclipse.jetty.http2.api.Session.Listener.onPreface.

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

the session

Returns:Map<Integer, Integer>

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

Annotations

@Override

Overrides default org.eclipse.jetty.http2.api.Stream.Listener.onPush.

Doc from org.eclipse.jetty.http2.api.Stream.Listener.onPush.

Callback method invoked when a PUSH_PROMISE frame has been received.

Applications that override this method are typically interested in processing the pushed stream DATA frames, and must demand for pushed DATA frames via Stream#demand() and then return either a Listener implementation that overrides onDataAvailable(Stream) where applications can read from the Stream via Stream#readData(), or 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 pushed DATA frames.

Parameters

stream:Stream

the pushed stream

frame:PushPromiseFrame

the PUSH_PROMISE frame received

Returns:Stream.Listener

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

Annotations

@Override

Overrides default org.eclipse.jetty.http2.api.Stream.Listener.onReset.

Doc from org.eclipse.jetty.http2.api.Stream.Listener.onReset.

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

Parameters

stream:Stream

the stream

frame:ResetFrame

the RST_STREAM frame received

callback:Callback

the callback to complete when the reset has been handled

Annotations

@Override