io.servicetalk.http.utils

Class TimeoutHttpRequesterFilter

Object

TimeoutHttpRequesterFilter

All Implemented Interfaces:

HttpExecutionStrategyInfluencer, StreamingHttpClientFilterFactory, StreamingHttpConnectionFilterFactory

public final class TimeoutHttpRequesterFilter
extends Object
implements StreamingHttpClientFilterFactory, StreamingHttpConnectionFilterFactory

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

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

If no executor is specified at construction an executor from HttpExecutionContext associated with the client or connection will be used. If the HttpExecutionContext.executionStrategy() specifies an HttpExecutionStrategy with offloads then ExecutionContext.executor() will be used and if no offloads are specified then ExecutionContext.ioExecutor() will be used.

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
TimeoutHttpRequesterFilter(Duration duration) Creates a new instance which requires only that the response metadata be received before the timeout.
TimeoutHttpRequesterFilter(Duration duration, boolean fullRequestResponse) Creates a new instance.
TimeoutHttpRequesterFilter(Duration duration, boolean fullRequestResponse, Executor timeoutExecutor) Creates a new instance.
TimeoutHttpRequesterFilter(Duration duration, Executor timeoutExecutor) Creates a new instance which requires only that the response metadata be received before the timeout.
TimeoutHttpRequesterFilter(TimeoutFromRequest timeoutForRequest, boolean fullRequestResponse) Creates a new instance.
TimeoutHttpRequesterFilter(TimeoutFromRequest timeoutForRequest, boolean fullRequestResponse, Executor timeoutExecutor) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
StreamingHttpClientFilter	create(FilterableStreamingHttpClient client)
StreamingHttpConnectionFilter	create(FilterableStreamingHttpConnection connection)
HttpExecutionStrategy	influenceStrategy(HttpExecutionStrategy strategy)

Methods inherited from class Object

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

Methods inherited from interface StreamingHttpClientFilterFactory

append, asMultiAddressClientFilter

Methods inherited from interface StreamingHttpConnectionFilterFactory

append

Methods inherited from interface HttpExecutionStrategyInfluencer

defaultStreamingInfluencer

Constructor Detail

TimeoutHttpRequesterFilter

public TimeoutHttpRequesterFilter(Duration duration)

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

Parameters:

duration - the timeout Duration

TimeoutHttpRequesterFilter

public TimeoutHttpRequesterFilter(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

TimeoutHttpRequesterFilter

public TimeoutHttpRequesterFilter(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

TimeoutHttpRequesterFilter

public TimeoutHttpRequesterFilter(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

TimeoutHttpRequesterFilter

public TimeoutHttpRequesterFilter(TimeoutFromRequest 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

TimeoutHttpRequesterFilter

public TimeoutHttpRequesterFilter(TimeoutFromRequest 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 StreamingHttpClientFilter create(FilterableStreamingHttpClient client)

Specified by:

create in interface StreamingHttpClientFilterFactory

create

public StreamingHttpConnectionFilter create(FilterableStreamingHttpConnection connection)

Specified by:

create in interface StreamingHttpConnectionFilterFactory

influenceStrategy

public final HttpExecutionStrategy influenceStrategy(HttpExecutionStrategy strategy)

Specified by:

influenceStrategy in interface HttpExecutionStrategyInfluencer