Package io.servicetalk.http.api

Class StreamingHttpServiceToOffloadedStreamingHttpService

java.lang.Object

io.servicetalk.http.api.StreamingHttpServiceToOffloadedStreamingHttpService

All Implemented Interfaces:

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

public class StreamingHttpServiceToOffloadedStreamingHttpService
extends Object
implements StreamingHttpService

Wraps a StreamingHttpService to apply the provided HttpExecutionStrategy and Executor for offloading.

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.
Single<StreamingHttpResponse>	handle(HttpServiceContext ctx, StreamingHttpRequest request, StreamingHttpResponseFactory responseFactory)	Handles a single HTTP request.
static StreamingHttpService	offloadService(HttpExecutionStrategy strategy, Executor executor, BooleanSupplier shouldOffload, StreamingHttpService service)	Wraps the passed StreamingHttpServiceToOffloadedStreamingHttpService to apply the provided HttpExecutionStrategy for offloading.

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

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

requiredOffloads

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.

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.

offloadService

public static StreamingHttpService offloadService(HttpExecutionStrategy strategy,
 @Nullable
 Executor executor,
 BooleanSupplier shouldOffload,
 StreamingHttpService service)

Wraps the passed StreamingHttpServiceToOffloadedStreamingHttpService to apply the provided HttpExecutionStrategy for offloading.

Parameters:

strategy - HttpExecutionStrategy to use for offloading.

executor - Executor to use as executor or null to use Execution context executor.

shouldOffload - If BooleanSupplier returns true then offload to executor otherwise continue execution on calling thread.

service - StreamingHttpServiceToOffloadedStreamingHttpService to wrap.

Returns:

Wrapped StreamingHttpServiceToOffloadedStreamingHttpService.