Class HttpStream.Wrapper

java.lang.Object

org.eclipse.jetty.server.HttpStream.Wrapper

All Implemented Interfaces:

HttpStream, Callback, Invocable

Enclosing interface:

HttpStream

public static class HttpStream.Wrapper
extends Object
implements HttpStream

Nested Class Summary

Nested classes/interfaces inherited from interface Callback

Callback.Combination, Callback.Completable, Callback.Completing, Callback.Nested

Nested classes/interfaces inherited from interface HttpStream

HttpStream.Wrapper

Nested classes/interfaces inherited from interface Invocable

Invocable.Callable, Invocable.InvocationType, Invocable.ReadyTask, Invocable.Task

Field Summary

Fields inherited from interface Callback

NOOP, NOT_CALLED

Fields inherited from interface HttpStream

CONTENT_NOT_CONSUMED, UPGRADE_CONNECTION_ATTRIBUTE

Fields inherited from interface Invocable

__nonBlocking

Constructor Summary

Constructors

Constructor	Description
Wrapper(HttpStream wrapped)

Method Summary

Modifier and Type	Method	Description
Runnable	cancelSend(Throwable cause, Callback appCallback)	Cancel any HttpStream.send(MetaData.Request, MetaData.Response, boolean, ByteBuffer, Callback) call in progress.
final Throwable	consumeAvailable()
void	demand()	Demands more content chunks to the underlying implementation.
void	failed(Throwable x)	Callback invoked when the operation fails.
final String	getId()
long	getIdleTimeout()
Invocable.InvocationType	getInvocationType()
TunnelSupport	getTunnelSupport()
HttpStream	getWrapped()
final boolean	isCommitted()
void	prepareResponse(HttpFields.Mutable headers)	Prepare the response headers with respect to the stream.
void	push(MetaData.Request resource)	Pushes the given resource to the client.
Content.Chunk	read()	Reads a chunk of content, with the same semantic as Content.Source.read().
void	send(MetaData.Request request, MetaData.Response response, boolean last, ByteBuffer content, Callback callback)	Send response meta-data and/or data.
void	setIdleTimeout(long idleTimeoutMs)
void	succeeded()	Callback invoked when the operation completes.

Methods inherited from class Object

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

Methods inherited from interface Callback

completeWith

Constructor Details

Wrapper

public Wrapper(HttpStream wrapped)

Method Details

getWrapped

public HttpStream getWrapped()

getId

public final String getId()

Specified by:

getId in interface HttpStream

Returns:

an ID unique within the lifetime scope of the associated protocol connection. This may be a protocol ID (e.g. HTTP/2 stream ID) or it may be unrelated to the protocol.

read

public Content.Chunk read()

Description copied from interface: HttpStream

Reads a chunk of content, with the same semantic as Content.Source.read().

This method is called from the implementation of Request.read().

Specified by:

read in interface HttpStream

Returns:

a chunk of content, possibly with non-null Content.Chunk.getFailure() or null.

demand

public void demand()

Description copied from interface: HttpStream

Demands more content chunks to the underlying implementation.

This method is called from the implementation of Request.demand(Runnable) and when the demand can be satisfied the implementation must call HttpChannel.onContentAvailable(). If there is a problem meeting demand, then the implementation must call HttpChannel.onFailure(Throwable).

Specified by:

demand in interface HttpStream

See Also:

• HttpChannel.onContentAvailable()
• HttpChannel.onFailure(Throwable)

prepareResponse

public void prepareResponse(HttpFields.Mutable headers)

Description copied from interface: HttpStream

Prepare the response headers with respect to the stream. Typically this may set headers related to protocol specific behaviour (e.g. Keep-Alive for HTTP/1.0 connections).

Specified by:

prepareResponse in interface HttpStream

Parameters:

headers - The headers to prepare.

send

public void send(MetaData.Request request,
 MetaData.Response response,
 boolean last,
 ByteBuffer content,
 Callback callback)

Description copied from interface: HttpStream

Send response meta-data and/or data.

Specified by:

send in interface HttpStream

Parameters:

request - The request metadata for which the response should be sent.

response - The response metadata to be sent or null if the response is already committed by a previous call to send.

last - True if this will be the last call to send and the response can be completed.

content - A buffer of content to send or null if no content.

callback - The callback to invoke when the send is completed successfully or in failure.

cancelSend

public Runnable cancelSend(Throwable cause,
 Callback appCallback)

Description copied from interface: HttpStream

Cancel any HttpStream.send(MetaData.Request, MetaData.Response, boolean, ByteBuffer, Callback) call in progress.

Specified by:

cancelSend in interface HttpStream

Parameters:

cause - The cause of the cancellation

appCallback - The callback to ultimately fail after the cancellation

Returns:

A Runnable that will be run to complete the cancellation and will, in turn, ultimately fail both the passed Callback and any Callback that was passed to the HttpStream.send(MetaData.Request, MetaData.Response, boolean, ByteBuffer, Callback) method.

push

public void push(MetaData.Request resource)

Description copied from interface: HttpStream

Pushes the given resource to the client.

Specified by:

push in interface HttpStream

Parameters:

resource - the resource to push

See Also:

• ConnectionMetaData.isPushSupported()

getIdleTimeout

public long getIdleTimeout()

Specified by:

getIdleTimeout in interface HttpStream

setIdleTimeout

public void setIdleTimeout(long idleTimeoutMs)

Specified by:

setIdleTimeout in interface HttpStream

isCommitted

public final boolean isCommitted()

Specified by:

isCommitted in interface HttpStream

getTunnelSupport

public TunnelSupport getTunnelSupport()

Specified by:

getTunnelSupport in interface HttpStream

consumeAvailable

public final Throwable consumeAvailable()

Specified by:

consumeAvailable in interface HttpStream

succeeded

public void succeeded()

Description copied from interface: Callback

Callback invoked when the operation completes.

Specified by:

succeeded in interface Callback

See Also:

• Callback.failed(Throwable)

failed

public void failed(Throwable x)

Description copied from interface: Callback

Callback invoked when the operation fails.

Specified by:

failed in interface Callback

Parameters:

x - the reason for the operation failure

getInvocationType

public Invocable.InvocationType getInvocationType()

Specified by:

getInvocationType in interface HttpStream

Specified by:

getInvocationType in interface Invocable

Returns:

The InvocationType of this object