io.servicetalk.http.api

Interface BlockingStreamingHttpClient

All Superinterfaces:

AutoCloseable, BlockingStreamingHttpRequester, BlockingStreamingHttpRequestFactory, GracefulAutoCloseable

public interface BlockingStreamingHttpClient
extends BlockingStreamingHttpRequester

The equivalent of StreamingHttpClient but with synchronous/blocking APIs instead of asynchronous APIs.

Method Summary

Modifier and Type	Method and Description
default BlockingHttpClient	asBlockingClient() Convert this BlockingStreamingHttpClient to the BlockingHttpClient API.
default HttpClient	asClient() Convert this BlockingStreamingHttpClient to the HttpClient API.
StreamingHttpClient	asStreamingClient() Convert this BlockingStreamingHttpClient to the StreamingHttpClient API.
BlockingStreamingHttpResponse	request(BlockingStreamingHttpRequest request) Send a request.
default ReservedBlockingStreamingHttpConnection	reserveConnection(HttpExecutionStrategy strategy, HttpRequestMetaData metaData) Deprecated. Use reserveConnection(HttpRequestMetaData). If an HttpExecutionStrategy needs to be altered, provide a value for HttpContextKeys.HTTP_EXECUTION_STRATEGY_KEY in the request context.
ReservedBlockingStreamingHttpConnection	reserveConnection(HttpRequestMetaData metaData) Reserve a BlockingStreamingHttpConnection based on provided HttpRequestMetaData.

Methods inherited from interface BlockingStreamingHttpRequester

close, executionContext, httpResponseFactory, request

Methods inherited from interface BlockingStreamingHttpRequestFactory

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

Methods inherited from interface GracefulAutoCloseable

closeGracefully

Method Detail

request

BlockingStreamingHttpResponse request(BlockingStreamingHttpRequest request)
                               throws Exception

Send a request.

Specified by:

request in interface BlockingStreamingHttpRequester

Parameters:

request - the request to send.

Returns:

The response.

Throws:

Exception - if an exception occurs during the request processing.

reserveConnection

ReservedBlockingStreamingHttpConnection reserveConnection(HttpRequestMetaData metaData)
                                                   throws Exception

Reserve a BlockingStreamingHttpConnection based on provided HttpRequestMetaData.

Parameters:

metaData - Allows the underlying layers to know what BlockingStreamingHttpConnections 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 ReservedBlockingStreamingHttpConnection.

Throws:

Exception - if a exception occurs during the reservation process.

reserveConnection

@Deprecated
default ReservedBlockingStreamingHttpConnection reserveConnection(HttpExecutionStrategy strategy,
                                                                              HttpRequestMetaData metaData)
                                                                       throws Exception

Deprecated. Use reserveConnection(HttpRequestMetaData). If an HttpExecutionStrategy needs to be altered, provide a value for HttpContextKeys.HTTP_EXECUTION_STRATEGY_KEY in the request context.

Reserve a BlockingStreamingHttpConnection based on provided HttpRequestMetaData.

Parameters:

strategy - HttpExecutionStrategy to use.

metaData - Allows the underlying layers to know what BlockingStreamingHttpConnections 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 ReservedBlockingStreamingHttpConnection.

Throws:

Exception - if an exception occurs during the reservation process.

asStreamingClient

StreamingHttpClient asStreamingClient()

Convert this BlockingStreamingHttpClient to the StreamingHttpClient API.

Note that the resulting StreamingHttpClient may still be subject to any blocking, in memory aggregation, and other behavior as this BlockingStreamingHttpClient.

Returns:

a StreamingHttpClient representation of this BlockingStreamingHttpClient.

asClient

default HttpClient asClient()

Convert this BlockingStreamingHttpClient to the HttpClient API.

Note that the resulting HttpClient may still be subject to any blocking, in memory aggregation, and other behavior as this BlockingStreamingHttpClient.

Returns:

a HttpClient representation of this BlockingStreamingHttpClient.

asBlockingClient

default BlockingHttpClient asBlockingClient()

Convert this BlockingStreamingHttpClient to the BlockingHttpClient API.

Note that the resulting BlockingHttpClient may still be subject to in memory aggregation and other behavior as this BlockingStreamingHttpClient.

Returns:

a BlockingHttpClient representation of this BlockingStreamingHttpClient.