Package org.eclipse.jetty.http3.client.http.internal

Class HttpReceiverOverHTTP3

java.lang.Object

org.eclipse.jetty.client.HttpReceiver

org.eclipse.jetty.http3.client.http.internal.HttpReceiverOverHTTP3

All Implemented Interfaces:

Stream.Client.Listener

public class HttpReceiverOverHTTP3
extends HttpReceiver
implements Stream.Client.Listener

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HttpReceiverOverHTTP3(HttpChannelOverHTTP3 channel)

Method Summary

Modifier and Type	Method	Description
protected HttpChannelOverHTTP3	getHttpChannel()
void	onDataAvailable(Stream.Client stream)	Callback method invoked if the application has expressed demand for content, and if there may be content available.
void	onFailure(Stream.Client stream, long error, Throwable failure)	Callback method invoked when a stream failure occurred.
boolean	onIdleTimeout(Stream.Client stream, Throwable failure)	Callback method invoked when the stream idle timeout elapses.
void	onNewStream(Stream.Client stream)	Callback method invoked when a stream is created locally by Session.Client.newRequest(HeadersFrame, Listener).
void	onResponse(Stream.Client stream, HeadersFrame frame)	Callback method invoked when a response is received.
void	onTrailer(Stream.Client stream, HeadersFrame frame)	Callback method invoked when a trailer is received.
protected void	receive()
protected void	reset()	Resets the state of this HttpReceiver.

Methods inherited from class org.eclipse.jetty.client.HttpReceiver

abort, demand, dispose, getHttpDestination, getHttpExchange, hasDemandOrStall, isFailed, responseBegin, responseContent, responseFailure, responseHeader, responseHeaders, responseSuccess, storeCookie, toString

Methods inherited from class java.lang.Object

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

Constructor Details

HttpReceiverOverHTTP3

protected HttpReceiverOverHTTP3(HttpChannelOverHTTP3 channel)

Method Details

getHttpChannel

protected HttpChannelOverHTTP3 getHttpChannel()

Overrides:

getHttpChannel in class HttpReceiver

receive

protected void receive()

Overrides:

receive in class HttpReceiver

onNewStream

public void onNewStream(Stream.Client stream)

Description copied from interface: Stream.Client.Listener

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

Specified by:

onNewStream in interface Stream.Client.Listener

Parameters:

stream - the newly created stream

onResponse

public void onResponse(Stream.Client stream,
 HeadersFrame frame)

Description copied from interface: Stream.Client.Listener

Callback method invoked when a response is received.

To read response content, applications should call Stream.demand() and override Stream.Client.Listener.onDataAvailable(Client).

Specified by:

onResponse in interface Stream.Client.Listener

Parameters:

stream - the stream

frame - the HEADERS frame containing the response headers

See Also:

• Stream.Client.Listener.onDataAvailable(Client)

onDataAvailable

public void onDataAvailable(Stream.Client stream)

Description copied from interface: Stream.Client.Listener

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

Specified by:

onDataAvailable in interface Stream.Client.Listener

Parameters:

stream - the stream

onTrailer

public void onTrailer(Stream.Client stream,
 HeadersFrame frame)

Description copied from interface: Stream.Client.Listener

Callback method invoked when a trailer is received.

Specified by:

onTrailer in interface Stream.Client.Listener

Parameters:

stream - the stream

frame - the HEADERS frame containing the trailer headers

onIdleTimeout

public boolean onIdleTimeout(Stream.Client stream,
 Throwable failure)

Description copied from interface: Stream.Client.Listener

Callback method invoked when the stream idle timeout elapses.

Specified by:

onIdleTimeout in interface Stream.Client.Listener

Parameters:

stream - the stream

failure - the timeout failure

Returns:

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

onFailure

public void onFailure(Stream.Client stream,
 long error,
 Throwable failure)

Description copied from interface: Stream.Client.Listener

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.

Specified by:

onFailure in interface Stream.Client.Listener

Parameters:

stream - the stream

error - the failure error

failure - the cause of the failure

reset

protected void reset()

Description copied from class: HttpReceiver

Resets the state of this HttpReceiver.

Subclasses should override (but remember to call super) to reset their own state.

Either this method or HttpReceiver.dispose() is called.

Overrides:

reset in class HttpReceiver