io.servicetalk.http.api

Interface StreamingHttpClient

All Superinterfaces:

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

public interface StreamingHttpClient
extends FilterableStreamingHttpClient

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

Method Summary

Modifier and Type	Method and 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.
Single<ReservedStreamingHttpConnection>	reserveConnection(HttpRequestMetaData metaData) Reserve a StreamingHttpConnection based on provided HttpRequestMetaData.

Methods inherited from interface StreamingHttpRequester

close, closeGracefully, executionContext, httpResponseFactory, request

Methods inherited from interface StreamingHttpRequestFactory

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

Methods inherited from interface ListenableAsyncCloseable

onClose, onClosing

Methods inherited from interface AsyncCloseable

closeAsync, closeAsyncGracefully

Method Detail

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.