public final class TimeoutHttpServiceFilter
extends Object
implements StreamingHttpServiceFilterFactory
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 and Description |
|---|
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)
Creates a new instance.
|
TimeoutHttpServiceFilter(TimeoutFromRequest timeoutForRequest,
boolean fullRequestResponse,
Executor timeoutExecutor)
Creates a new instance.
|
| Modifier and Type | Method and Description |
|---|---|
StreamingHttpServiceFilter |
create(StreamingHttpService service) |
HttpExecutionStrategy |
influenceStrategy(HttpExecutionStrategy strategy) |
public TimeoutHttpServiceFilter(Duration duration)
duration - the timeout Durationpublic TimeoutHttpServiceFilter(Duration duration,
Executor timeoutExecutor)
duration - the timeout DurationtimeoutExecutor - the Executor to use for managing the timer notificationspublic TimeoutHttpServiceFilter(Duration duration,
boolean fullRequestResponse)
duration - the timeout DurationfullRequestResponse - if true then timeout is for full request/response transaction otherwise only
the response metadata must arrive before the timeoutpublic TimeoutHttpServiceFilter(Duration duration,
boolean fullRequestResponse,
Executor timeoutExecutor)
duration - the timeout DurationfullRequestResponse - if true then timeout is for full request/response transaction otherwise only
the response metadata must arrive before the timeouttimeoutExecutor - the Executor to use for managing the timer notificationspublic TimeoutHttpServiceFilter(TimeoutFromRequest timeoutForRequest, boolean fullRequestResponse)
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 nullfullRequestResponse - if true then timeout is for full request/response transaction otherwise only
the response metadata must arrive before the timeoutpublic TimeoutHttpServiceFilter(TimeoutFromRequest timeoutForRequest, boolean fullRequestResponse, Executor timeoutExecutor)
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 nullfullRequestResponse - if true then timeout is for full request/response transaction otherwise only
the response metadata must arrive before the timeouttimeoutExecutor - the Executor to use for managing the timer notificationspublic StreamingHttpServiceFilter create(StreamingHttpService service)
create in interface StreamingHttpServiceFilterFactorypublic final HttpExecutionStrategy influenceStrategy(HttpExecutionStrategy strategy)
influenceStrategy in interface HttpExecutionStrategyInfluencer