Package io.servicetalk.http.utils

Class IdleTimeoutConnectionFilter

java.lang.Object

io.servicetalk.http.utils.IdleTimeoutConnectionFilter

All Implemented Interfaces:

HttpExecutionStrategyInfluencer, StreamingHttpConnectionFilterFactory, ExecutionStrategyInfluencer<HttpExecutionStrategy>

public final class IdleTimeoutConnectionFilter
extends Object
implements StreamingHttpConnectionFilterFactory

A connection-level filter that closes idle connections.

This filter is an alternative to ServiceTalkSocketOptions.IDLE_TIMEOUT at L7 layer. It helps to close idle connections that were not used to send any requests for the specified duration without affecting any in-flight requests.

• Connections that have in-flight requests are considered "in-use".
• If response payload body was not consumed, the connection is still considered "in-use" and does not start counting the timer.
• A single connection can not process more than Integer.MAX_VALUE concurrent requests.
• If filter is configured with Duration.ZERO timeout, it disables the timeout.

Constructor Summary

Constructors

Constructor	Description
IdleTimeoutConnectionFilter(Duration timeout)	Creates a new instance.
IdleTimeoutConnectionFilter(Duration timeout, 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.
String	toString()

Methods inherited from class java.lang.Object

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

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

influenceStrategy

Constructor Details

IdleTimeoutConnectionFilter

public IdleTimeoutConnectionFilter(Duration timeout)

Creates a new instance.

Parameters:

timeout - timeout duration after which an idle connection is closed, if Duration.ZERO the timeout is disabled

IdleTimeoutConnectionFilter

public IdleTimeoutConnectionFilter(Duration timeout,
 Executor timeoutExecutor)

Creates a new instance.

Parameters:

timeout - timeout duration after which an idle connection is closed, if Duration.ZERO the timeout is disabled

timeoutExecutor - the Executor to use for scheduling 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.

toString

public String toString()

Overrides:

toString in class Object