io.servicetalk.http.api

Interface StreamingHttpService

All Superinterfaces:

AsyncCloseable, ExecutionStrategyInfluencer<HttpExecutionStrategy>, HttpExecutionStrategyInfluencer

All Known Implementing Classes:

StreamingHttpServiceFilter, StreamingHttpServiceToOffloadedStreamingHttpService

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface StreamingHttpService
extends AsyncCloseable, HttpExecutionStrategyInfluencer

A service contract for the HTTP protocol.

Method Summary

Modifier and Type	Method and Description
default Completable	closeAsync() Closes this StreamingHttpService asynchronously.
Single<StreamingHttpResponse>	handle(HttpServiceContext ctx, StreamingHttpRequest request, StreamingHttpResponseFactory responseFactory) Handles a single HTTP request.
default HttpExecutionStrategy	requiredOffloads()

Methods inherited from interface AsyncCloseable

closeAsyncGracefully

Methods inherited from interface HttpExecutionStrategyInfluencer

defaultStreamingInfluencer, influenceStrategy

Method Detail

handle

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

Handles a single HTTP request.

Parameters:

ctx - Context of the service.

request - to handle.

responseFactory - used to create StreamingHttpResponse objects.

Returns:

Single of HTTP response.

closeAsync

default Completable closeAsync()

Closes this StreamingHttpService asynchronously.

Specified by:

closeAsync in interface AsyncCloseable

Returns:

Completable that when subscribed will close this StreamingHttpService.

requiredOffloads

default HttpExecutionStrategy requiredOffloads()

Description copied from interface: HttpExecutionStrategyInfluencer

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

Specified by:

requiredOffloads in interface ExecutionStrategyInfluencer<HttpExecutionStrategy>

Specified by:

requiredOffloads in interface HttpExecutionStrategyInfluencer