Package io.servicetalk.http.api

Interface StreamingHttpConnection

All Superinterfaces:

AsyncCloseable, AutoCloseable, FilterableStreamingHttpConnection, GracefulAutoCloseable, ListenableAsyncCloseable, StreamingHttpRequester, StreamingHttpRequestFactory

All Known Subinterfaces:

FilterableStreamingHttpLoadBalancedConnection, ReservedStreamingHttpConnection

All Known Implementing Classes:

DelegatingFilterableStreamingHttpLoadBalancedConnection, HttpLoadBalancerFactory.DefaultFilterableStreamingHttpLoadBalancedConnection

public interface StreamingHttpConnection
extends FilterableStreamingHttpConnection, GracefulAutoCloseable

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

Method Summary

Modifier and Type	Method	Description
BlockingHttpConnection	asBlockingConnection()	Convert this StreamingHttpConnection to the BlockingHttpConnection API.
BlockingStreamingHttpConnection	asBlockingStreamingConnection()	Convert this StreamingHttpConnection to the BlockingStreamingHttpConnection API.
HttpConnection	asConnection()	Convert this StreamingHttpConnection to the HttpConnection 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.

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

closeAsync, closeAsyncGracefully

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

connectionContext, transportEventStream

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

asConnection

HttpConnection asConnection()

Convert this StreamingHttpConnection to the HttpConnection API.

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

Returns:

a HttpConnection representation of this StreamingHttpConnection.

asBlockingStreamingConnection

BlockingStreamingHttpConnection asBlockingStreamingConnection()

Convert this StreamingHttpConnection to the BlockingStreamingHttpConnection API.

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

Returns:

a BlockingStreamingHttpConnection representation of this StreamingHttpConnection.

asBlockingConnection

BlockingHttpConnection asBlockingConnection()

Convert this StreamingHttpConnection to the BlockingHttpConnection API.

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

Returns:

a BlockingHttpConnection representation of this StreamingHttpConnection.

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.