Package io.servicetalk.http.api

Class StreamingHttpServiceFilter

java.lang.Object

io.servicetalk.http.api.StreamingHttpServiceFilter

All Implemented Interfaces:

AsyncCloseable, HttpExecutionStrategyInfluencer, HttpServiceBase, StreamingHttpService, ExecutionStrategyInfluencer<HttpExecutionStrategy>

public class StreamingHttpServiceFilter
extends Object
implements StreamingHttpService

An implementation of StreamingHttpService that delegates all methods to the provided StreamingHttpService.

See Also:

• StreamingHttpServiceFilterFactory

Constructor Summary

Constructors

Constructor	Description
StreamingHttpServiceFilter(StreamingHttpService delegate)	New instance.

Method Summary

Modifier and Type	Method	Description
Completable	closeAsync()	Closes this StreamingHttpService asynchronously.
Completable	closeAsyncGracefully()	Used to close/shutdown a resource, similar to AsyncCloseable.closeAsync(), but attempts to cleanup state before abruptly closing.
protected final StreamingHttpService	delegate()	Returns StreamingHttpService to which all calls are delegated.
Single<StreamingHttpResponse>	handle(HttpServiceContext ctx, StreamingHttpRequest request, StreamingHttpResponseFactory responseFactory)	Handles a single HTTP request.
HttpExecutionStrategy	requiredOffloads()	Return an ExecutionStrategy that describes the offloads required by the influencer.

Methods inherited from class java.lang.Object

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

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

influenceStrategy

Constructor Details

StreamingHttpServiceFilter

public StreamingHttpServiceFilter(StreamingHttpService delegate)

New instance.

Parameters:

delegate - StreamingHttpService to delegate all calls.

Method Details

handle

public Single<StreamingHttpResponse> handle(HttpServiceContext ctx,
 StreamingHttpRequest request,
 StreamingHttpResponseFactory responseFactory)

Description copied from interface: StreamingHttpService

Handles a single HTTP request.

Specified by:

handle in interface StreamingHttpService

Parameters:

ctx - Context of the service.

request - to handle.

responseFactory - used to create StreamingHttpResponse objects.

Returns:

Single of HTTP response.

requiredOffloads

public HttpExecutionStrategy requiredOffloads()

Description copied from interface: HttpExecutionStrategyInfluencer

Return an ExecutionStrategy that describes the offloads required by the influencer.

The provided default implementation requests offloading of all operations. Implementations that require no offloading should be careful to return HttpExecutionStrategies.offloadNone() rather than HttpExecutionStrategies.offloadNever(). Implementations should avoid returning HttpExecutionStrategies.defaultStrategy(), instead returning the strategy they require or HttpExecutionStrategies.offloadAll() if offloading for all paths is required (safe default).

Specified by:

requiredOffloads in interface ExecutionStrategyInfluencer<HttpExecutionStrategy>

Specified by:

requiredOffloads in interface HttpExecutionStrategyInfluencer

Specified by:

requiredOffloads in interface StreamingHttpService

Returns:

the ExecutionStrategy required by the influencer.

closeAsync

public Completable closeAsync()

Description copied from interface: StreamingHttpService

Closes this StreamingHttpService asynchronously.

Specified by:

closeAsync in interface AsyncCloseable

Specified by:

closeAsync in interface StreamingHttpService

Returns:

Completable that when subscribed will close this StreamingHttpService.

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.

delegate

protected final StreamingHttpService delegate()

Returns StreamingHttpService to which all calls are delegated.

Returns:

StreamingHttpService to which all calls are delegated.