Package io.servicetalk.http.api

Class DelegatingFilterableStreamingHttpLoadBalancedConnection

java.lang.Object

io.servicetalk.http.api.DelegatingFilterableStreamingHttpLoadBalancedConnection

All Implemented Interfaces:

LoadBalancedConnection, RequestConcurrencyController, ReservableRequestConcurrencyController, ScoreSupplier, AsyncCloseable, ListenableAsyncCloseable, GracefulAutoCloseable, FilterableReservedStreamingHttpConnection, FilterableStreamingHttpConnection, FilterableStreamingHttpLoadBalancedConnection, ReservedStreamingHttpConnection, StreamingHttpConnection, StreamingHttpRequester, StreamingHttpRequestFactory, AutoCloseable

public class DelegatingFilterableStreamingHttpLoadBalancedConnection
extends Object
implements FilterableStreamingHttpLoadBalancedConnection

Implementation of FilterableStreamingHttpLoadBalancedConnection that delegates all methods.

Nested Class Summary

Nested classes/interfaces inherited from interface io.servicetalk.client.api.RequestConcurrencyController

RequestConcurrencyController.Result

Constructor Summary

Constructors

Constructor	Description
DelegatingFilterableStreamingHttpLoadBalancedConnection(FilterableStreamingHttpLoadBalancedConnection delegate)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
void	close()
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.
void	closeGracefully()	Used to close/shutdown a resource, similar to AutoCloseable.close(), but attempts to cleanup state before abruptly closing.
StreamingHttpRequest	connect(String requestTarget)	Create a new HttpRequestMethod.CONNECT request.
HttpConnectionContext	connectionContext()	Get the HttpConnectionContext.
StreamingHttpRequest	delete(String requestTarget)	Create a new HttpRequestMethod.DELETE request.
HttpExecutionContext	executionContext()	Get the HttpExecutionContext used during construction of this object.
StreamingHttpRequest	get(String requestTarget)	Create a new HttpRequestMethod.GET request.
StreamingHttpRequest	head(String requestTarget)	Create a new HttpRequestMethod.HEAD request.
StreamingHttpResponseFactory	httpResponseFactory()	Get a StreamingHttpResponseFactory.
StreamingHttpRequest	newRequest(HttpRequestMethod method, String requestTarget)	Create a new HttpRequestFactory.
Completable	onClose()	Returns a Completable that is notified once the ListenableAsyncCloseable was closed.
Completable	onClosing()	Returns a Completable that is notified when closing begins.
StreamingHttpRequest	options(String requestTarget)	Create a new HttpRequestMethod.OPTIONS request.
StreamingHttpRequest	patch(String requestTarget)	Create a new HttpRequestMethod.PATCH request.
StreamingHttpRequest	post(String requestTarget)	Create a new HttpRequestMethod.POST request.
StreamingHttpRequest	put(String requestTarget)	Create a new HttpRequestMethod.PUT request.
Completable	releaseAsync()	Must be called (and subscribed to) to signify the reservation has completed after ReservableRequestConcurrencyController.tryReserve().
Single<StreamingHttpResponse>	request(StreamingHttpRequest request)	Send a request.
void	requestFinished()	Must be called after RequestConcurrencyController.tryRequest() to signify the request has completed.
int	score()	Returns the current score of a resource.
String	toString()
StreamingHttpRequest	trace(String requestTarget)	Create a new HttpRequestMethod.TRACE request.
<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.
RequestConcurrencyController.Result	tryRequest()	Attempts to reserve a connection for a single request, needs to be followed by RequestConcurrencyController.requestFinished().
boolean	tryReserve()	Attempts to reserve a connection for exclusive use until ReservableRequestConcurrencyController.releaseAsync() is called.

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.FilterableStreamingHttpLoadBalancedConnection

asBlockingConnection, asBlockingStreamingConnection, asConnection

Constructor Details

DelegatingFilterableStreamingHttpLoadBalancedConnection

public DelegatingFilterableStreamingHttpLoadBalancedConnection(FilterableStreamingHttpLoadBalancedConnection delegate)

Create a new instance.

Parameters:

delegate - The instance to delegate to.

Method Details

tryRequest

public RequestConcurrencyController.Result tryRequest()

Description copied from interface: RequestConcurrencyController

Attempts to reserve a connection for a single request, needs to be followed by RequestConcurrencyController.requestFinished().

Specified by:

tryRequest in interface LoadBalancedConnection

Specified by:

tryRequest in interface RequestConcurrencyController

Returns:

RequestConcurrencyController.Result.Accepted if this connection is available and reserved for performing a single request.

requestFinished

public void requestFinished()

Description copied from interface: RequestConcurrencyController

Must be called after RequestConcurrencyController.tryRequest() to signify the request has completed. This method should be called no more than once for each call to RequestConcurrencyController.tryRequest().

Generally called from a Publisher.beforeFinally(Runnable) after a RequestConcurrencyController.tryRequest().

Specified by:

requestFinished in interface LoadBalancedConnection

Specified by:

requestFinished in interface RequestConcurrencyController

tryReserve

public boolean tryReserve()

Description copied from interface: ReservableRequestConcurrencyController

Attempts to reserve a connection for exclusive use until ReservableRequestConcurrencyController.releaseAsync() is called.

Specified by:

tryReserve in interface LoadBalancedConnection

Specified by:

tryReserve in interface ReservableRequestConcurrencyController

Returns:

true if this connection is available and reserved for performing a single request.

score

public int score()

Description copied from interface: ScoreSupplier

Returns the current score of a resource. LoadBalancers prefer resources with a higher score.

Specified by:

score in interface ScoreSupplier

Returns:

the score

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.

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.

onClosing

public Completable onClosing()

Description copied from interface: ListenableAsyncCloseable

Returns a Completable that is notified when closing begins.

Closing begin might be when a close operation is initiated locally (e.g. subscribing to AsyncCloseable.closeAsync()) or it could also be a transport event received from a remote peer (e.g. read a connection: close header).

For backwards compatibility this method maybe functionally equivalent to ListenableAsyncCloseable.onClose(). Therefore, provides a best-effort leading edge notification of closing, but may fall back to notification on trailing edge.

The goal of this method is often to notify asap when closing so this method may not be offloaded and care must be taken to avoid blocking if subscribing to the return Completable.

Specified by:

onClosing in interface ListenableAsyncCloseable

Returns:

a Completable that is notified when closing begins.

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.

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Specified by:

close in interface StreamingHttpConnection

Throws:

Exception

closeGracefully

public void closeGracefully()
                     throws Exception

Description copied from interface: GracefulAutoCloseable

Used to close/shutdown a resource, similar to AutoCloseable.close(), 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 AutoCloseable.close().

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 AutoCloseable.close().

Specified by:

closeGracefully in interface GracefulAutoCloseable

Specified by:

closeGracefully in interface StreamingHttpConnection

Throws:

Exception - if graceful closure failed.

releaseAsync

public Completable releaseAsync()

Description copied from interface: ReservableRequestConcurrencyController

Must be called (and subscribed to) to signify the reservation has completed after ReservableRequestConcurrencyController.tryReserve().

Specified by:

releaseAsync in interface FilterableReservedStreamingHttpConnection

Specified by:

releaseAsync in interface FilterableStreamingHttpLoadBalancedConnection

Specified by:

releaseAsync in interface LoadBalancedConnection

Specified by:

releaseAsync in interface ReservableRequestConcurrencyController

Returns:

a Completable for the release.

newRequest

public StreamingHttpRequest newRequest(HttpRequestMethod method,
 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.

get

public StreamingHttpRequest get(String requestTarget)

Description copied from interface: StreamingHttpRequestFactory

Create a new HttpRequestMethod.GET request.

Specified by:

get in interface StreamingHttpRequestFactory

Parameters:

requestTarget - The request target.

Returns:

a new HttpRequestMethod.GET request.

post

public StreamingHttpRequest post(String requestTarget)

Description copied from interface: StreamingHttpRequestFactory

Create a new HttpRequestMethod.POST request.

Specified by:

post in interface StreamingHttpRequestFactory

Parameters:

requestTarget - The request target.

Returns:

a new HttpRequestMethod.POST request.

put

public StreamingHttpRequest put(String requestTarget)

Description copied from interface: StreamingHttpRequestFactory

Create a new HttpRequestMethod.PUT request.

Specified by:

put in interface StreamingHttpRequestFactory

Parameters:

requestTarget - The request target.

Returns:

a new HttpRequestMethod.PUT request.

options

public StreamingHttpRequest options(String requestTarget)

Description copied from interface: StreamingHttpRequestFactory

Create a new HttpRequestMethod.OPTIONS request.

Specified by:

options in interface StreamingHttpRequestFactory

Parameters:

requestTarget - The request target.

Returns:

a new HttpRequestMethod.OPTIONS request.

head

public StreamingHttpRequest head(String requestTarget)

Description copied from interface: StreamingHttpRequestFactory

Create a new HttpRequestMethod.HEAD request.

Specified by:

head in interface StreamingHttpRequestFactory

Parameters:

requestTarget - The request target.

Returns:

a new HttpRequestMethod.HEAD request.

trace

public StreamingHttpRequest trace(String requestTarget)

Description copied from interface: StreamingHttpRequestFactory

Create a new HttpRequestMethod.TRACE request.

Specified by:

trace in interface StreamingHttpRequestFactory

Parameters:

requestTarget - The request target.

Returns:

a new HttpRequestMethod.TRACE request.

delete

public StreamingHttpRequest delete(String requestTarget)

Description copied from interface: StreamingHttpRequestFactory

Create a new HttpRequestMethod.DELETE request.

Specified by:

delete in interface StreamingHttpRequestFactory

Parameters:

requestTarget - The request target.

Returns:

a new HttpRequestMethod.DELETE request.

patch

public StreamingHttpRequest patch(String requestTarget)

Description copied from interface: StreamingHttpRequestFactory

Create a new HttpRequestMethod.PATCH request.

Specified by:

patch in interface StreamingHttpRequestFactory

Parameters:

requestTarget - The request target.

Returns:

a new HttpRequestMethod.PATCH request.

connect

public StreamingHttpRequest connect(String requestTarget)

Description copied from interface: StreamingHttpRequestFactory

Create a new HttpRequestMethod.CONNECT request.

Specified by:

connect in interface StreamingHttpRequestFactory

Parameters:

requestTarget - The request target.

Returns:

a new HttpRequestMethod.CONNECT request.

request

public Single<StreamingHttpResponse> request(StreamingHttpRequest request)

Description copied from interface: StreamingHttpRequester

Send a request.

Specified by:

request in interface StreamingHttpRequester

Parameters:

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.

toString

public String toString()

Overrides:

toString in class Object