io.servicetalk.http.api

Interface HttpExecutionStrategy

All Superinterfaces:

ExecutionStrategy

public interface HttpExecutionStrategy
extends ExecutionStrategy

An execution strategy for HTTP client and servers.

Method Summary

Modifier and Type	Method and Description
<FS> Single<StreamingHttpResponse>	invokeClient(Executor fallback, Publisher<Object> flattenedRequest, FS flushStrategy, ClientInvoker<FS> client) Invokes the passed Function and applies the necessary offloading of request and response for a client.
<T> Single<T>	invokeService(Executor fallback, Function<Executor,T> service) Invokes a service represented by the passed Function.
Publisher<Object>	invokeService(Executor fallback, StreamingHttpRequest request, Function<StreamingHttpRequest,Publisher<Object>> service, BiFunction<Throwable,Executor,Publisher<Object>> errorHandler) Deprecated. Will be removed as part of improved offloading strategy. If you need this API please file an issue explaining the use case.
boolean	isDataReceiveOffloaded() Returns true if data receive offloading is enabled for this ExecutionStrategy.
boolean	isMetadataReceiveOffloaded() Returns true if metadata receive offloading is enabled for this ExecutionStrategy.
boolean	isSendOffloaded() Returns true if send offloading is enabled for this ExecutionStrategy.
HttpExecutionStrategy	merge(HttpExecutionStrategy other) Merges the passed HttpExecutionStrategy with this HttpExecutionStrategy and return the merged result.
StreamingHttpService	offloadService(Executor fallback, StreamingHttpService handler) Wraps the passed StreamingHttpService to apply this HttpExecutionStrategy.

Methods inherited from interface ExecutionStrategy

executor, offloadReceive, offloadReceive, offloadSend, offloadSend

Method Detail

invokeClient

<FS> Single<StreamingHttpResponse> invokeClient(Executor fallback,
                                                Publisher<Object> flattenedRequest,
                                                @Nullable
                                                FS flushStrategy,
                                                ClientInvoker<FS> client)

Invokes the passed Function and applies the necessary offloading of request and response for a client.

Type Parameters:

FS - The FlushStrategy type to use.

Parameters:

fallback - Executor to use as a fallback if this HttpExecutionStrategy does not define an Executor.

flattenedRequest - A flattened Publisher containing all data constituting an HTTP request.

flushStrategy - The FlushStrategy to use.

client - A BiFunction that given flattened stream of HttpRequestMetaData, payload and trailers, for the passed StreamingHttpRequest returns a Single.

Returns:

Single which is offloaded as required.

invokeService

@Deprecated
Publisher<Object> invokeService(Executor fallback,
                                            StreamingHttpRequest request,
                                            Function<StreamingHttpRequest,Publisher<Object>> service,
                                            BiFunction<Throwable,Executor,Publisher<Object>> errorHandler)

Deprecated. Will be removed as part of improved offloading strategy. If you need this API please file an issue explaining the use case.

Invokes the passed Function and applies the necessary offloading of request and response for a server.

Parameters:

fallback - Executor to use as a fallback if this HttpExecutionStrategy does not define an Executor.

request - StreamingHttpRequest for which the offloading is to be applied.

service - A Function that executes a StreamingHttpRequest and returns a flattened Publisher containing all data constituting an HTTP response.

errorHandler - In case there is an error before calling the passed service, this BiFunction will be called to generate an error response.

Returns:

A flattened Publisher containing all data constituting an HTTP response.

invokeService

<T> Single<T> invokeService(Executor fallback,
                            Function<Executor,T> service)

Invokes a service represented by the passed Function.

This method does not apply the strategy on the object returned from the Function, if that object is an asynchronous source then the caller of this method should take care and offload that source using ExecutionStrategy.offloadSend(Executor, Single) or ExecutionStrategy.offloadSend(Executor, Publisher).

Type Parameters:

T - Type of result of the invocation of the service.

Parameters:

fallback - Executor to use as a fallback if this HttpExecutionStrategy does not define an Executor.

service - Function representing a service.

Returns:

A Single that invokes the passed Function and returns the result asynchronously. Invocation of Function will be offloaded if configured.

offloadService

StreamingHttpService offloadService(Executor fallback,
                                    StreamingHttpService handler)

Wraps the passed StreamingHttpService to apply this HttpExecutionStrategy.

Parameters:

fallback - Executor to use as a fallback if this HttpExecutionStrategy does not define an Executor.

handler - StreamingHttpService to wrap.

Returns:

Wrapped StreamingHttpService.

isMetadataReceiveOffloaded

boolean isMetadataReceiveOffloaded()

Returns true if metadata receive offloading is enabled for this ExecutionStrategy.

Returns:

true if metadata receive offloading is enabled for this ExecutionStrategy.

isDataReceiveOffloaded

boolean isDataReceiveOffloaded()

Returns true if data receive offloading is enabled for this ExecutionStrategy.

Returns:

true if data receive offloading is enabled for this ExecutionStrategy.

isSendOffloaded

boolean isSendOffloaded()

Returns true if send offloading is enabled for this ExecutionStrategy.

Returns:

true if send offloading is enabled for this ExecutionStrategy.

merge

HttpExecutionStrategy merge(HttpExecutionStrategy other)

Merges the passed HttpExecutionStrategy with this HttpExecutionStrategy and return the merged result.

Parameters:

other - HttpExecutionStrategy to merge with this.

Returns:

Merged HttpExecutionStrategy.