Interface Stream.Server.Listener

Enclosing interface:
Stream.Server
public static interface Stream.Server.Listener

A Stream.Server.Listener is the passive counterpart of a Stream.Server and receives server-side events happening on an HTTP/3 stream.

See Also:

  • Method Details

    • onDataAvailable

      default void onDataAvailable(Stream.Server stream)

      A simplified version of onDataAvailable(Stream.Server, boolean).

      The default implementation of this method reads and discards data.

      Parameters:
      stream - the stream
      See Also:

    • onDataAvailable

      default void onDataAvailable(Stream.Server stream, boolean immediate)

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

      A server application that wishes to handle request content should typically call Stream.demand() from Session.Server.Listener.onRequest(Server, HeadersFrame).

      A client application that wishes to handle response content should typically call Stream.demand() from Stream.Client.Listener.onResponse(Client, HeadersFrame).

      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.Server.Listener
{
    @Override
    public void onDataAvailable(Stream.Server stream, boolean immediate)
    {
        // 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.getByteBuffer());
            // Notify that the content has been consumed.
            data.release();
            if (!data.isLast())
            {
                // Demand to be called back.
                stream.demand();
            }
        }
    }
}

      The default implementation of this method calls onDataAvailable(Stream.Server).

      Parameters:
      stream - the stream
      immediate - true when data is immediately available at the time Stream.demand() is invoked (this method is directly invoked from Stream.demand(); false when data was not immediately available at the time Stream.demand() was called, but is now available (this method is invoked from the network layer, not directly from Stream.demand()
      See Also:

    • onTrailer

      default void onTrailer(Stream.Server stream, HeadersFrame frame)

      Callback method invoked when a trailer is received.

      Parameters:
      stream - the stream
      frame - the HEADERS frame containing the trailer headers

    • onIdleTimeout

      default void onIdleTimeout(Stream.Server stream, TimeoutException failure, Promise<Boolean> promise)

      Callback method invoked when the stream idle timeout elapses.

      Parameters:
      stream - the stream
      failure - the timeout failure
      promise - the promise to complete with true to reset the stream, false to ignore the idle timeout

    • onFailure

      default void onFailure(Stream.Server stream, long error, Throwable failure)

      Callback method invoked when a stream failure occurred.

      Typical stream failures, among others, are failures to decode a HEADERS frame, or failures to read bytes because the stream has been reset.

      Parameters:
      stream - the stream
      error - the failure error
      failure - the cause of the failure