io.servicetalk.http.utils

Class TimeoutHttpServiceFilter

Object

TimeoutHttpServiceFilter

All Implemented Interfaces:

HttpExecutionStrategyInfluencer, StreamingHttpServiceFilterFactory, ExecutionStrategyInfluencer<HttpExecutionStrategy>

public final class TimeoutHttpServiceFilter
extends Object
implements StreamingHttpServiceFilterFactory

A filter to enable timeouts for HTTP requests on the server-side.

The timeout applies either the response metadata (headers) completion or the complete reception of the response payload body and optional trailers.

The order with which this filter is applied may be highly significant. For example, appending it before a retry filter would have different results than applying it after the retry filter; timeout would apply for all retries vs timeout per retry.

Constructor Summary

Constructors

Constructor and Description
TimeoutHttpServiceFilter(BiFunction<HttpRequestMetaData,TimeSource,Duration> timeoutForRequest, boolean fullRequestResponse) Creates a new instance.
TimeoutHttpServiceFilter(BiFunction<HttpRequestMetaData,TimeSource,Duration> timeoutForRequest, boolean fullRequestResponse, Executor timeoutExecutor) Creates a new instance.
TimeoutHttpServiceFilter(Duration duration) Creates a new instance which requires only that the response metadata be received before the timeout.
TimeoutHttpServiceFilter(Duration duration, boolean fullRequestResponse) Creates a new instance.
TimeoutHttpServiceFilter(Duration duration, boolean fullRequestResponse, Executor timeoutExecutor) Creates a new instance.
TimeoutHttpServiceFilter(Duration duration, Executor timeoutExecutor) Creates a new instance which requires only that the response metadata be received before the timeout.
TimeoutHttpServiceFilter(TimeoutFromRequest timeoutForRequest, boolean fullRequestResponse) Deprecated. Use TimeoutHttpServiceFilter(BiFunction, boolean).
TimeoutHttpServiceFilter(TimeoutFromRequest timeoutForRequest, boolean fullRequestResponse, Executor timeoutExecutor) Deprecated. Use TimeoutHttpServiceFilter(BiFunction, boolean, Executor).

Method Summary

Modifier and Type	Method and Description
StreamingHttpServiceFilter	create(StreamingHttpService service)
HttpExecutionStrategy	requiredOffloads()

Methods inherited from class Object

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

Methods inherited from interface HttpExecutionStrategyInfluencer

defaultStreamingInfluencer, influenceStrategy, requiredOffloads

Constructor Detail

TimeoutHttpServiceFilter

public TimeoutHttpServiceFilter(Duration duration)

Creates a new instance which requires only that the response metadata be received before the timeout.

Parameters:

duration - the timeout Duration

TimeoutHttpServiceFilter

public TimeoutHttpServiceFilter(Duration duration,
                                Executor timeoutExecutor)

Creates a new instance which requires only that the response metadata be received before the timeout.

Parameters:

duration - the timeout Duration

timeoutExecutor - the Executor to use for managing the timer notifications

TimeoutHttpServiceFilter

public TimeoutHttpServiceFilter(Duration duration,
                                boolean fullRequestResponse)

Creates a new instance.

Parameters:

duration - the timeout Duration

fullRequestResponse - if true then timeout is for full request/response transaction otherwise only the response metadata must arrive before the timeout

TimeoutHttpServiceFilter

public TimeoutHttpServiceFilter(Duration duration,
                                boolean fullRequestResponse,
                                Executor timeoutExecutor)

Creates a new instance.

Parameters:

duration - the timeout Duration

fullRequestResponse - if true then timeout is for full request/response transaction otherwise only the response metadata must arrive before the timeout

timeoutExecutor - the Executor to use for managing the timer notifications

TimeoutHttpServiceFilter

@Deprecated
public TimeoutHttpServiceFilter(TimeoutFromRequest timeoutForRequest,
                                            boolean fullRequestResponse)

Deprecated. Use TimeoutHttpServiceFilter(BiFunction, boolean).

Creates a new instance.

Parameters:

timeoutForRequest - function for extracting timeout from request which may also determine the timeout using other sources. If no timeout is to be applied then the function should return null

fullRequestResponse - if true then timeout is for full request/response transaction otherwise only the response metadata must arrive before the timeout

TimeoutHttpServiceFilter

public TimeoutHttpServiceFilter(BiFunction<HttpRequestMetaData,TimeSource,Duration> timeoutForRequest,
                                boolean fullRequestResponse)

Creates a new instance.

Parameters:

timeoutForRequest - function for extracting timeout from request which may also determine the timeout using other sources. If no timeout is to be applied then the function should return null

fullRequestResponse - if true then timeout is for full request/response transaction otherwise only the response metadata must arrive before the timeout

TimeoutHttpServiceFilter

@Deprecated
public TimeoutHttpServiceFilter(TimeoutFromRequest timeoutForRequest,
                                            boolean fullRequestResponse,
                                            Executor timeoutExecutor)

Deprecated. Use TimeoutHttpServiceFilter(BiFunction, boolean, Executor).

Creates a new instance.

Parameters:

timeoutForRequest - function for extracting timeout from request which may also determine the timeout using other sources. If no timeout is to be applied then the function should return null

fullRequestResponse - if true then timeout is for full request/response transaction otherwise only the response metadata must arrive before the timeout

timeoutExecutor - the Executor to use for managing the timer notifications

TimeoutHttpServiceFilter

public TimeoutHttpServiceFilter(BiFunction<HttpRequestMetaData,TimeSource,Duration> timeoutForRequest,
                                boolean fullRequestResponse,
                                Executor timeoutExecutor)

Creates a new instance.

Parameters:

timeoutForRequest - function for extracting timeout from request which may also determine the timeout using other sources. If no timeout is to be applied then the function should return null

fullRequestResponse - if true then timeout is for full request/response transaction otherwise only the response metadata must arrive before the timeout

timeoutExecutor - the Executor to use for managing the timer notifications

Method Detail

create

public StreamingHttpServiceFilter create(StreamingHttpService service)

Specified by:

create in interface StreamingHttpServiceFilterFactory

requiredOffloads

public final HttpExecutionStrategy requiredOffloads()

Specified by:

requiredOffloads in interface HttpExecutionStrategyInfluencer

Specified by:

requiredOffloads in interface ExecutionStrategyInfluencer<HttpExecutionStrategy>