io.servicetalk.http.utils

Class IdleTimeoutConnectionFilter

Object

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 and Description
IdleTimeoutConnectionFilter(Duration timeout) Creates a new instance.
IdleTimeoutConnectionFilter(Duration timeout, Executor timeoutExecutor) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
StreamingHttpConnectionFilter	create(FilterableStreamingHttpConnection connection)
HttpExecutionStrategy	requiredOffloads()
String	toString()

Methods inherited from class Object

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

Methods inherited from interface HttpExecutionStrategyInfluencer

defaultStreamingInfluencer, influenceStrategy

Constructor Detail

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 Detail

create

public StreamingHttpConnectionFilter create(FilterableStreamingHttpConnection connection)

Specified by:

create in interface StreamingHttpConnectionFilterFactory

requiredOffloads

public HttpExecutionStrategy requiredOffloads()

Specified by:

requiredOffloads in interface HttpExecutionStrategyInfluencer

Specified by:

requiredOffloads in interface ExecutionStrategyInfluencer<HttpExecutionStrategy>

toString

public String toString()

Overrides:

toString in class Object