Package io.servicetalk.http.utils

Class JavaNetSoTimeoutHttpConnectionFilter

java.lang.Object

io.servicetalk.http.utils.JavaNetSoTimeoutHttpConnectionFilter

All Implemented Interfaces:

HttpExecutionStrategyInfluencer, StreamingHttpConnectionFilterFactory, ExecutionStrategyInfluencer<HttpExecutionStrategy>

public final class JavaNetSoTimeoutHttpConnectionFilter
extends Object
implements StreamingHttpConnectionFilterFactory

A filter that mimics SocketOptions.SO_TIMEOUT behavior on the client-side.

While TimeoutHttpRequesterFilter applies a timeout for the overall duration to receive either the response metadata (headers) or the complete reception of the response (including headers, payload body, optional trailers, as well as time to send the request), this filter applies timeout to every independent read operation: read of 100 (Continue) response, read of response headers, read of every response payload body chunk, read of optional trailers. Note that the time to send the request is not accounted. Also, if the remote server is sending a large payload body, the timeout will be applied on every chunk read, which may result in unpredictable time to read the full response if the remote slowly sends 1 byte within the timeout boundaries. Use this filter only for compatibility with classic blocking Java libraries. To protect from the described use-cases, consider also appending TimeoutHttpRequesterFilter before applying this filter in the filter chain.

This filter implements only StreamingHttpConnectionFilterFactory and therefore can be applied only at the connection level. This restriction ensures that the timeout is applied only for the response read operations (similar to SocketOptions.SO_TIMEOUT used by Java blocking API), without waiting for selecting or establishing a connection.

SocketTimeoutException (or its subtype) will be propagated when the timeout is reached.

See Also:

• TimeoutHttpRequesterFilter
• SocketOptions.SO_TIMEOUT
• Socket.setSoTimeout(int)

Constructor Summary

Constructors

Constructor	Description
JavaNetSoTimeoutHttpConnectionFilter(Duration duration)	Creates a new instance.
JavaNetSoTimeoutHttpConnectionFilter(Duration duration, Executor timeoutExecutor)	Creates a new instance.
JavaNetSoTimeoutHttpConnectionFilter(BiFunction<HttpRequestMetaData,TimeSource,Duration> timeoutForRequest)	Creates a new instance.
JavaNetSoTimeoutHttpConnectionFilter(BiFunction<HttpRequestMetaData,TimeSource,Duration> timeoutForRequest, Executor timeoutExecutor)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
StreamingHttpConnectionFilter	create(FilterableStreamingHttpConnection connection)	Create a StreamingHttpConnectionFilter using the provided FilterableStreamingHttpConnection.
HttpExecutionStrategy	requiredOffloads()	Return an ExecutionStrategy that describes the offloads required by the influencer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

influenceStrategy

Constructor Details

JavaNetSoTimeoutHttpConnectionFilter

public JavaNetSoTimeoutHttpConnectionFilter(Duration duration)

Creates a new instance.

Parameters:

duration - the timeout Duration, must be > 0

JavaNetSoTimeoutHttpConnectionFilter

public JavaNetSoTimeoutHttpConnectionFilter(Duration duration,
 Executor timeoutExecutor)

Creates a new instance.

Parameters:

duration - the timeout Duration, must be > 0

timeoutExecutor - the Executor to use for managing the timer notifications

JavaNetSoTimeoutHttpConnectionFilter

public JavaNetSoTimeoutHttpConnectionFilter(BiFunction<HttpRequestMetaData,TimeSource,Duration> timeoutForRequest)

Creates a new instance.

Parameters:

timeoutForRequest - function for extracting timeout value from a request or other runtime sources. A timeout of null or zero (0) is interpreted as an infinite timeout, all other values must be > 0

JavaNetSoTimeoutHttpConnectionFilter

public JavaNetSoTimeoutHttpConnectionFilter(BiFunction<HttpRequestMetaData,TimeSource,Duration> timeoutForRequest,
 Executor timeoutExecutor)

Creates a new instance.

Parameters:

timeoutForRequest - function for extracting timeout value from a request or other runtime sources. A timeout of null or zero (0) is interpreted as an infinite timeout, all other values must be > 0

timeoutExecutor - the Executor to use for managing the timer notifications

Method Details

create

public StreamingHttpConnectionFilter create(FilterableStreamingHttpConnection connection)

Description copied from interface: StreamingHttpConnectionFilterFactory

Create a StreamingHttpConnectionFilter using the provided FilterableStreamingHttpConnection.

Specified by:

create in interface StreamingHttpConnectionFilterFactory

Parameters:

connection - FilterableStreamingHttpConnection to filter

Returns:

StreamingHttpConnectionFilter using the provided FilterableStreamingHttpConnection.

requiredOffloads

public HttpExecutionStrategy requiredOffloads()

Description copied from interface: HttpExecutionStrategyInfluencer

Return an ExecutionStrategy that describes the offloads required by the influencer.

The provided default implementation requests offloading of all operations. Implementations that require no offloading should be careful to return HttpExecutionStrategies.offloadNone() rather than HttpExecutionStrategies.offloadNever(). Implementations should avoid returning HttpExecutionStrategies.defaultStrategy(), instead returning the strategy they require or HttpExecutionStrategies.offloadAll() if offloading for all paths is required (safe default).

Specified by:

requiredOffloads in interface ExecutionStrategyInfluencer<HttpExecutionStrategy>

Specified by:

requiredOffloads in interface HttpExecutionStrategyInfluencer

Returns:

the ExecutionStrategy required by the influencer.