Package io.servicetalk.http.api

Interface StreamingHttpRequester

All Superinterfaces:

AsyncCloseable, AutoCloseable, GracefulAutoCloseable, ListenableAsyncCloseable, StreamingHttpRequestFactory

All Known Subinterfaces:

FilterableReservedStreamingHttpConnection, FilterableStreamingHttpClient, FilterableStreamingHttpConnection, FilterableStreamingHttpLoadBalancedConnection, ReservedStreamingHttpConnection, StreamingHttpClient, StreamingHttpConnection

All Known Implementing Classes:

DelegatingFilterableStreamingHttpLoadBalancedConnection, HttpLoadBalancerFactory.DefaultFilterableStreamingHttpLoadBalancedConnection, ReservedStreamingHttpConnectionFilter, StreamingHttpClientFilter, StreamingHttpConnectionFilter

public interface StreamingHttpRequester
extends StreamingHttpRequestFactory, ListenableAsyncCloseable, GracefulAutoCloseable

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

Method Summary

Modifier and Type	Method	Description
default void	close()
default void	closeGracefully()	Used to close/shutdown a resource, similar to AutoCloseable.close(), but attempts to cleanup state before abruptly closing.
HttpExecutionContext	executionContext()	Get the HttpExecutionContext used during construction of this object.
StreamingHttpResponseFactory	httpResponseFactory()	Get a StreamingHttpResponseFactory.
Single<StreamingHttpResponse>	request(StreamingHttpRequest request)	Send a request.

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.StreamingHttpRequestFactory

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

Method Details

request

Single<StreamingHttpResponse> request(StreamingHttpRequest request)

Send a request.

Parameters:

request - the request to send.

Returns:

The response.

executionContext

HttpExecutionContext executionContext()

Get the HttpExecutionContext used during construction of this object.

Note that the ExecutionContext.ioExecutor() will not necessarily be associated with a specific thread unless that was how this object was built.

Returns:

the HttpExecutionContext used during construction of this object.

httpResponseFactory

StreamingHttpResponseFactory httpResponseFactory()

Get a StreamingHttpResponseFactory.

Returns:

a StreamingHttpResponseFactory.

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.