io.servicetalk.http.utils

Interface TimeoutFromRequest

All Superinterfaces:

ExecutionStrategyInfluencer<HttpExecutionStrategy>, Function<HttpRequestMetaData,Duration>, HttpExecutionStrategyInfluencer

Deprecated.

In areas which require TimeoutFromRequest use variants that accept BiFunction<HttpRequestMetaData, TimeSource, Duration>. E.g.: TimeoutHttpRequesterFilter(BiFunction, boolean), TimeoutHttpServiceFilter(BiFunction, boolean) for filters.

@Deprecated
public interface TimeoutFromRequest
extends Function<HttpRequestMetaData,Duration>, HttpExecutionStrategyInfluencer, ExecutionStrategyInfluencer<HttpExecutionStrategy>

A function to determine the appropriate timeout to be used for a given HTTP request. The result is a Duration which may be null if no timeout is to be applied. If the function blocks then influenceStrategy(HttpExecutionStrategy) should alter the execution strategy as required.

Method Summary

Modifier and Type	Method and Description
Duration	apply(HttpRequestMetaData request) Deprecated. Determine timeout duration, if present, from a request and/or apply default timeout durations.
default HttpExecutionStrategy	influenceStrategy(HttpExecutionStrategy strategy) Deprecated.
default HttpExecutionStrategy	requiredOffloads() Deprecated.
static TimeoutFromRequest	toTimeoutFromRequest(Function<HttpRequestMetaData,Duration> function, HttpExecutionStrategy requiredStrategy) Deprecated. In areas which require TimeoutFromRequest use variants that accept BiFunction<HttpRequestMetaData, TimeSource, Duration>. E.g.: TimeoutHttpRequesterFilter(BiFunction, boolean), TimeoutHttpServiceFilter(BiFunction, boolean) for filters. Note that passed BiFunction should never block.

Methods inherited from interface Function

andThen, compose, identity

Methods inherited from interface HttpExecutionStrategyInfluencer

defaultStreamingInfluencer

Method Detail

apply

@Nullable
Duration apply(HttpRequestMetaData request)

Deprecated.

Determine timeout duration, if present, from a request and/or apply default timeout durations.

Specified by:

apply in interface Function<HttpRequestMetaData,Duration>

Parameters:

request - the current request

Returns:

The timeout or null for no timeout

influenceStrategy

default HttpExecutionStrategy influenceStrategy(HttpExecutionStrategy strategy)

Deprecated.

If it is known that apply() cannot block then override to return strategy as provided.

Specified by:

influenceStrategy in interface HttpExecutionStrategyInfluencer

requiredOffloads

default HttpExecutionStrategy requiredOffloads()

Deprecated.

Specified by:

requiredOffloads in interface ExecutionStrategyInfluencer<HttpExecutionStrategy>

Specified by:

requiredOffloads in interface HttpExecutionStrategyInfluencer

toTimeoutFromRequest

@Deprecated
static TimeoutFromRequest toTimeoutFromRequest(Function<HttpRequestMetaData,Duration> function,
                                                           HttpExecutionStrategy requiredStrategy)

Deprecated. In areas which require TimeoutFromRequest use variants that accept BiFunction<HttpRequestMetaData, TimeSource, Duration>. E.g.: TimeoutHttpRequesterFilter(BiFunction, boolean), TimeoutHttpServiceFilter(BiFunction, boolean) for filters. Note that passed BiFunction should never block.

Create a TimeoutFromRequest instance.

Parameters:

function - a function for converting request headers to a duration

requiredStrategy - execution strategy required by the function.

Returns:

TimeoutFromRequest instance which applies the provided function and requires the specified strategy.