io.servicetalk.http.api

Interface HttpClient

All Superinterfaces:

AsyncCloseable, java.lang.AutoCloseable, GracefulAutoCloseable, HttpRequester, HttpRequestFactory, ListenableAsyncCloseable

public interface HttpClient
extends HttpRequester, GracefulAutoCloseable

Provides a means to issue requests against HTTP service. The implementation is free to maintain a collection of HttpConnection instances and distribute calls to request(HttpRequest) amongst this collection.

Method Summary

Modifier and Type	Method and Description
default BlockingHttpClient	asBlockingClient() Convert this HttpClient to the BlockingHttpClient API.
default BlockingStreamingHttpClient	asBlockingStreamingClient() Convert this HttpClient to the BlockingStreamingHttpClient API.
StreamingHttpClient	asStreamingClient() Convert this HttpClient to the StreamingHttpClient API.
default void	close()
default void	closeGracefully() Used to close/shutdown a resource, similar to AutoCloseable.close(), but attempts to cleanup state before abruptly closing.
Single<HttpResponse>	request(HttpRequest request) Send a request.
Single<ReservedHttpConnection>	reserveConnection(HttpExecutionStrategy strategy, HttpRequestMetaData metaData) Reserve an HttpConnection based on provided HttpRequestMetaData.
Single<ReservedHttpConnection>	reserveConnection(HttpRequestMetaData metaData) Reserve an HttpConnection based on provided HttpRequestMetaData.

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

executionContext, httpResponseFactory, request

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

connect, delete, get, head, newRequest, options, patch, post, put, trace

Methods inherited from interface io.servicetalk.concurrent.api.ListenableAsyncCloseable

onClose

Methods inherited from interface io.servicetalk.concurrent.api.AsyncCloseable

closeAsync, closeAsyncGracefully

Method Detail

request

Single<HttpResponse> request(HttpRequest request)

Send a request.

Parameters:

request - the request to send.

Returns:

The response.

reserveConnection

Single<ReservedHttpConnection> reserveConnection(HttpRequestMetaData metaData)

Reserve an HttpConnection based on provided HttpRequestMetaData.

Parameters:

metaData - Allows the underlying layers to know what HttpConnections are valid to reserve for future requests with the same HttpRequestMetaData. For example this may provide some insight into shard or other info.

Returns:

a Single that provides the ReservedHttpConnection upon completion.

reserveConnection

Single<ReservedHttpConnection> reserveConnection(HttpExecutionStrategy strategy,
                                                 HttpRequestMetaData metaData)

Reserve an HttpConnection based on provided HttpRequestMetaData.

Note: reserved connections may not be restricted by the max pipelined requests count.

Parameters:

strategy - HttpExecutionStrategy to use.

metaData - Allows the underlying layers to know what HttpConnections are valid to reserve for future requests with the same HttpRequestMetaData. For example this may provide some insight into shard or other info.

Returns:

a Single that provides the ReservedHttpConnection upon completion.

asStreamingClient

StreamingHttpClient asStreamingClient()

Convert this HttpClient to the StreamingHttpClient API.

Returns:

a StreamingHttpClient representation of this HttpClient.

asBlockingStreamingClient

default BlockingStreamingHttpClient asBlockingStreamingClient()

Convert this HttpClient to the BlockingStreamingHttpClient API.

Returns:

a BlockingStreamingHttpClient representation of this HttpClient.

asBlockingClient

default BlockingHttpClient asBlockingClient()

Convert this HttpClient to the BlockingHttpClient API.

Returns:

a BlockingHttpClient representation of this HttpClient.

close

default void close()
            throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception

closeGracefully

default void closeGracefully()
                      throws java.lang.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

Throws:

java.lang.Exception - if graceful closure failed.