Interface StreamingHttpConnection
-
- All Superinterfaces:
AsyncCloseable
,java.lang.AutoCloseable
,FilterableStreamingHttpConnection
,GracefulAutoCloseable
,ListenableAsyncCloseable
,StreamingHttpRequester
,StreamingHttpRequestFactory
- All Known Subinterfaces:
ReservedStreamingHttpConnection
public interface StreamingHttpConnection extends FilterableStreamingHttpConnection, GracefulAutoCloseable
The equivalent ofHttpConnection
but that acceptsStreamingHttpRequest
and returnsStreamingHttpResponse
.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description BlockingHttpConnection
asBlockingConnection()
Convert thisStreamingHttpConnection
to theBlockingHttpConnection
API.BlockingStreamingHttpConnection
asBlockingStreamingConnection()
Convert thisStreamingHttpConnection
to theBlockingStreamingHttpConnection
API.HttpConnection
asConnection()
Convert thisStreamingHttpConnection
to theHttpConnection
API.default void
close()
default void
closeGracefully()
Used to close/shutdown a resource, similar toAutoCloseable.close()
, but attempts to cleanup state before abruptly closing.Single<StreamingHttpResponse>
request(StreamingHttpRequest request)
Send arequest
.-
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
-
Methods inherited from interface io.servicetalk.http.api.StreamingHttpRequester
executionContext, httpResponseFactory, request
-
-
-
-
Method Detail
-
request
Single<StreamingHttpResponse> request(StreamingHttpRequest request)
Send arequest
.- Parameters:
request
- the request to send.- Returns:
- The response.
-
asConnection
HttpConnection asConnection()
Convert thisStreamingHttpConnection
to theHttpConnection
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 thisStreamingHttpConnection
.
-
asBlockingStreamingConnection
BlockingStreamingHttpConnection asBlockingStreamingConnection()
Convert thisStreamingHttpConnection
to theBlockingStreamingHttpConnection
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 thisStreamingHttpConnection
.
-
asBlockingConnection
BlockingHttpConnection asBlockingConnection()
Convert thisStreamingHttpConnection
to theBlockingHttpConnection
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 thisStreamingHttpConnection
.
-
close
default void close() throws java.lang.Exception
- Specified by:
close
in interfacejava.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 toAutoCloseable.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 toAutoCloseable.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 interfaceGracefulAutoCloseable
- Throws:
java.lang.Exception
- if graceful closure failed.
-
-