Package io.servicetalk.http.api

Interface StreamingHttpClient

All Superinterfaces:

AsyncCloseable, AutoCloseable, FilterableStreamingHttpClient, GracefulAutoCloseable, ListenableAsyncCloseable, StreamingHttpRequester, StreamingHttpRequestFactory

public interface StreamingHttpClient
extends FilterableStreamingHttpClient, GracefulAutoCloseable

The equivalent of HttpClient but that accepts StreamingHttpRequest and returns StreamingHttpResponse.

Method Summary

Modifier and Type	Method	Description
BlockingHttpClient	asBlockingClient()	Convert this StreamingHttpClient to the BlockingHttpClient API.
BlockingStreamingHttpClient	asBlockingStreamingClient()	Convert this StreamingHttpClient to the BlockingStreamingHttpClient API.
HttpClient	asClient()	Convert this StreamingHttpClient to the HttpClient 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<ReservedStreamingHttpConnection>	reserveConnection(HttpRequestMetaData metaData)	Reserve a StreamingHttpConnection based on provided HttpRequestMetaData.

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

closeAsync, closeAsyncGracefully

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

onClose, onClosing

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

executionContext, httpResponseFactory, request

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

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

Method Details

reserveConnection

Single<ReservedStreamingHttpConnection> reserveConnection(HttpRequestMetaData metaData)

Reserve a StreamingHttpConnection based on provided HttpRequestMetaData.

If a new connection should be opened instead of potentially reusing an already established one, the HttpContextKeys.HTTP_FORCE_NEW_CONNECTION must be set.

Specified by:

reserveConnection in interface FilterableStreamingHttpClient

Parameters:

metaData - Allows the underlying layers to know what StreamingHttpConnections 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 ReservedStreamingHttpConnection upon completion.

See Also:

• HttpContextKeys.HTTP_FORCE_NEW_CONNECTION

asClient

HttpClient asClient()

Convert this StreamingHttpClient to the HttpClient API.

This API is provided for convenience. It is recommended that filters are implemented using the StreamingHttpClient asynchronous API for maximum portability.

Returns:

a HttpClient representation of this StreamingHttpRequester.

asBlockingStreamingClient

BlockingStreamingHttpClient asBlockingStreamingClient()

Convert this StreamingHttpClient to the BlockingStreamingHttpClient API.

This API is provided for convenience for a more familiar sequential programming model. It is recommended that filters are implemented using the StreamingHttpClient asynchronous API for maximum portability.

Returns:

a BlockingStreamingHttpClient representation of this StreamingHttpClient.

asBlockingClient

BlockingHttpClient asBlockingClient()

Convert this StreamingHttpClient to the BlockingHttpClient API.

This API is provided for convenience for a more familiar sequential programming model. It is recommended that filters are implemented using the StreamingHttpClient asynchronous API for maximum portability.

Returns:

a BlockingHttpClient representation of this StreamingHttpClient.

close

default void close()
            throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

closeGracefully

default void closeGracefully()
                      throws 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:

Exception - if graceful closure failed.