Package 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	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.
ReservedBlockingStreamingHttpConnection	reserveConnection(HttpRequestMetaData metaData)	Reserve a BlockingStreamingHttpConnection based on provided HttpRequestMetaData.

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

close, executionContext, httpResponseFactory, request

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

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

Methods inherited from interface io.servicetalk.concurrent.GracefulAutoCloseable

closeGracefully

Method Details

reserveConnection

ReservedBlockingStreamingHttpConnection reserveConnection(HttpRequestMetaData metaData)
                                                   throws Exception

Reserve a BlockingStreamingHttpConnection 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.

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.

See Also:

• HttpContextKeys.HTTP_FORCE_NEW_CONNECTION

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.