Package io.servicetalk.http.api

Class ReservedStreamingHttpConnectionFilter

java.lang.Object

io.servicetalk.http.api.ReservedStreamingHttpConnectionFilter

All Implemented Interfaces:

AsyncCloseable, ListenableAsyncCloseable, FilterableReservedStreamingHttpConnection, FilterableStreamingHttpConnection, StreamingHttpRequester, StreamingHttpRequestFactory

public class ReservedStreamingHttpConnectionFilter
extends java.lang.Object
implements FilterableReservedStreamingHttpConnection

A ReservedStreamingHttpConnectionFilter that delegates all methods to a different ReservedStreamingHttpConnectionFilter.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ReservedStreamingHttpConnectionFilter(FilterableReservedStreamingHttpConnection delegate)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
Completable	closeAsync()	Used to close/shutdown a resource.
Completable	closeAsyncGracefully()	Used to close/shutdown a resource, similar to AsyncCloseable.closeAsync(), but attempts to cleanup state before abruptly closing.
HttpConnectionContext	connectionContext()	Get the HttpConnectionContext.
protected FilterableReservedStreamingHttpConnection	delegate()	Get the ReservedStreamingHttpConnection this method delegates to.
HttpExecutionContext	executionContext()	Get the HttpExecutionContext used during construction of this object.
StreamingHttpResponseFactory	httpResponseFactory()	Get a StreamingHttpResponseFactory.
StreamingHttpRequest	newRequest(HttpRequestMethod method, java.lang.String requestTarget)	Create a new HttpRequestFactory.
Completable	onClose()	Returns a Completable that is notified once the ListenableAsyncCloseable was closed.
Completable	releaseAsync()	Releases this reserved FilterableStreamingHttpConnection to be used for subsequent requests.
Single<StreamingHttpResponse>	request(HttpExecutionStrategy strategy, StreamingHttpRequest request)	Send a request using the specified strategy.
protected Single<StreamingHttpResponse>	request(StreamingHttpRequester delegate, HttpExecutionStrategy strategy, StreamingHttpRequest request)	Called when the filter needs to delegate the request using the provided StreamingHttpRequester on which to call StreamingHttpRequester.request(HttpExecutionStrategy, StreamingHttpRequest).
java.lang.String	toString()
<T> Publisher<? extends T>	transportEventStream(HttpEventKey<T> eventKey)	Returns a Publisher that gives the current value of a transport event as well as subsequent changes to the event value as long as the PublisherSource.Subscriber has expressed enough demand.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.servicetalk.http.api.StreamingHttpRequestFactory

connect, delete, get, head, options, patch, post, put, trace

Constructor Detail

ReservedStreamingHttpConnectionFilter

protected ReservedStreamingHttpConnectionFilter(FilterableReservedStreamingHttpConnection delegate)

Create a new instance.

Parameters:

delegate - The FilterableReservedStreamingHttpConnection to delegate all calls to

Method Detail

releaseAsync

public Completable releaseAsync()

Description copied from interface: FilterableReservedStreamingHttpConnection

Releases this reserved FilterableStreamingHttpConnection to be used for subsequent requests. This method must be idempotent, i.e. calling multiple times must not have side-effects.

Specified by:

releaseAsync in interface FilterableReservedStreamingHttpConnection

Returns:

the Completable that is notified on releaseAsync.

connectionContext

public HttpConnectionContext connectionContext()

Description copied from interface: FilterableStreamingHttpConnection

Get the HttpConnectionContext.

Specified by:

connectionContext in interface FilterableStreamingHttpConnection

Returns:

the HttpConnectionContext.

transportEventStream

public <T> Publisher<? extends T> transportEventStream(HttpEventKey<T> eventKey)

Description copied from interface: FilterableStreamingHttpConnection

Returns a Publisher that gives the current value of a transport event as well as subsequent changes to the event value as long as the PublisherSource.Subscriber has expressed enough demand.

This is designed for events produced by the transport, and consumed by filters interested in transport behavior which is not directly involved in the data path.

Specified by:

transportEventStream in interface FilterableStreamingHttpConnection

Type Parameters:

T - Type of the event value.

Parameters:

eventKey - Name of the event to fetch.

Returns:

Publisher for the event values.

request

public final Single<StreamingHttpResponse> request(HttpExecutionStrategy strategy,
                                                   StreamingHttpRequest request)

Description copied from interface: StreamingHttpRequester

Send a request using the specified strategy.

Specified by:

request in interface StreamingHttpRequester

Parameters:

strategy - HttpExecutionStrategy to use for executing the request.

request - the request to send.

Returns:

The response.

executionContext

public HttpExecutionContext executionContext()

Description copied from interface: StreamingHttpRequester

Get the HttpExecutionContext used during construction of this object.

Note that the ExecutionContext.ioExecutor() will not necessarily be associated with a specific thread unless that was how this object was built.

Specified by:

executionContext in interface StreamingHttpRequester

Returns:

the HttpExecutionContext used during construction of this object.

httpResponseFactory

public StreamingHttpResponseFactory httpResponseFactory()

Description copied from interface: StreamingHttpRequester

Get a StreamingHttpResponseFactory.

Specified by:

httpResponseFactory in interface StreamingHttpRequester

Returns:

a StreamingHttpResponseFactory.

onClose

public Completable onClose()

Description copied from interface: ListenableAsyncCloseable

Returns a Completable that is notified once the ListenableAsyncCloseable was closed.

Specified by:

onClose in interface ListenableAsyncCloseable

Returns:

the Completable that is notified on close.

closeAsync

public Completable closeAsync()

Description copied from interface: AsyncCloseable

Used to close/shutdown a resource.

Specified by:

closeAsync in interface AsyncCloseable

Returns:

A Completable that is notified once the close is complete.

closeAsyncGracefully

public Completable closeAsyncGracefully()

Description copied from interface: AsyncCloseable

Used to close/shutdown a resource, similar to AsyncCloseable.closeAsync(), but attempts to cleanup state before abruptly closing. This provides a hint that implementations can use to stop accepting new work and finish in flight work. This method is implemented on a "best effort" basis and may be equivalent to AsyncCloseable.closeAsync().

Note: Implementations may or may not apply a timeout for this operation to complete, if a caller does not want to wait indefinitely, and are unsure if the implementation applies a timeout, it is advisable to apply a timeout and force a call to AsyncCloseable.closeAsync().

Specified by:

closeAsyncGracefully in interface AsyncCloseable

Returns:

A Completable that is notified once the close is complete.

newRequest

public StreamingHttpRequest newRequest(HttpRequestMethod method,
                                       java.lang.String requestTarget)

Description copied from interface: StreamingHttpRequestFactory

Create a new HttpRequestFactory.

Specified by:

newRequest in interface StreamingHttpRequestFactory

Parameters:

method - The HttpRequestMethod.

requestTarget - The request target.

Returns:

a new HttpRequestFactory.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

delegate

protected final FilterableReservedStreamingHttpConnection delegate()

Get the ReservedStreamingHttpConnection this method delegates to.

Returns:

the ReservedStreamingHttpConnection this method delegates to.

request

protected Single<StreamingHttpResponse> request(StreamingHttpRequester delegate,
                                                HttpExecutionStrategy strategy,
                                                StreamingHttpRequest request)

Called when the filter needs to delegate the request using the provided StreamingHttpRequester on which to call StreamingHttpRequester.request(HttpExecutionStrategy, StreamingHttpRequest).

Parameters:

delegate - The StreamingHttpRequester to delegate requests to.

strategy - The HttpExecutionStrategy to use for executing the request.

request - The request to delegate.

Returns:

the response.