io.servicetalk.http.api

Interface HttpConnection

All Superinterfaces:

AsyncCloseable, java.lang.AutoCloseable, GracefulAutoCloseable, HttpRequester, HttpRequestFactory, ListenableAsyncCloseable

All Known Subinterfaces:

ReservedHttpConnection

public interface HttpConnection
extends HttpRequester, GracefulAutoCloseable

Represents a single fixed connection to a HTTP server.

Method Summary

Modifier and Type	Method and Description
default BlockingHttpConnection	asBlockingConnection() Convert this HttpConnection to the BlockingHttpConnection API.
default BlockingStreamingHttpConnection	asBlockingStreamingConnection() Convert this HttpConnection to the BlockingStreamingHttpConnection API.
StreamingHttpConnection	asStreamingConnection() Convert this HttpConnection to the StreamingHttpConnection 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.
ConnectionContext	connectionContext() Get the ConnectionContext.
Single<HttpResponse>	request(HttpRequest request) Send a request.
<T> Publisher<? extends T>	transportEventStream(HttpEventKey<T> eventKey) Returns a Publisher that gives the current value of a transport event as well as subsequent changes to the event value as long as the PublisherSource.Subscriber has expressed enough demand.

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

executionContext, httpResponseFactory, request

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

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

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

onClose

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

closeAsync, closeAsyncGracefully

Method Detail

request

Single<HttpResponse> request(HttpRequest request)

Send a request.

Parameters:

request - the request to send.

Returns:

The response.

connectionContext

ConnectionContext connectionContext()

Get the ConnectionContext.

Returns:

the ConnectionContext.

transportEventStream

<T> Publisher<? extends T> transportEventStream(HttpEventKey<T> eventKey)

Returns a Publisher that gives the current value of a transport event as well as subsequent changes to the event value as long as the PublisherSource.Subscriber has expressed enough demand.

This is designed for events produced by the transport, and consumed by filters interested in transport behavior which is not directly involved in the data path.

Type Parameters:

T - Type of the event value.

Parameters:

eventKey - Name of the event to fetch.

Returns:

Publisher for the event values.

asStreamingConnection

StreamingHttpConnection asStreamingConnection()

Convert this HttpConnection to the StreamingHttpConnection API.

Returns:

a StreamingHttpConnection representation of this HttpConnection.

asBlockingStreamingConnection

default BlockingStreamingHttpConnection asBlockingStreamingConnection()

Convert this HttpConnection to the BlockingStreamingHttpConnection API.

Returns:

a BlockingStreamingHttpConnection representation of this HttpConnection.

asBlockingConnection

default BlockingHttpConnection asBlockingConnection()

Convert this HttpConnection to the BlockingHttpConnection API.

Returns:

a BlockingHttpConnection representation of this HttpConnection.

close

default void close()
            throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception

closeGracefully

default void closeGracefully()
                      throws java.lang.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:

java.lang.Exception - if graceful closure failed.