Package io.servicetalk.http.utils

Interface TimeoutFromRequest

All Superinterfaces:

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

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

Deprecated.

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

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 requiredOffloads() should specify the execution strategy as required.

Method Summary

Modifier and Type	Method	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. Optionally modify the passed HttpExecutionStrategy to a new HttpExecutionStrategy that suits this HttpExecutionStrategyInfluencer.
default HttpExecutionStrategy	requiredOffloads()	Deprecated. Return an ExecutionStrategy that describes the offloads required by the influencer.
static TimeoutFromRequest	toTimeoutFromRequest(Function<HttpRequestMetaData,Duration> function, HttpExecutionStrategy requiredStrategy)	Deprecated. In areas which require TimeoutFromRequest use variants that accept BiFunction<HttpRequestMetaData, TimeSource, Duration>.

Methods inherited from interface java.util.function.Function

andThen, compose

Method Details

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.

Optionally modify the passed HttpExecutionStrategy to a new HttpExecutionStrategy that suits this HttpExecutionStrategyInfluencer.

Implementations should not return HttpExecutionStrategies.defaultStrategy() unless it was also provided as input.

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

Specified by:

influenceStrategy in interface HttpExecutionStrategyInfluencer

Parameters:

strategy - HttpExecutionStrategy to influence.

Returns:

HttpExecutionStrategy that suits this HttpExecutionStrategyInfluencer

requiredOffloads

default HttpExecutionStrategy requiredOffloads()

Deprecated.

Description copied from interface: HttpExecutionStrategyInfluencer

Return an ExecutionStrategy that describes the offloads required by the influencer.

The provided default implementation requests offloading of all operations. Implementations that require no offloading should be careful to return HttpExecutionStrategies.offloadNone() rather than HttpExecutionStrategies.offloadNever(). Implementations should avoid returning HttpExecutionStrategies.defaultStrategy(), instead returning the strategy they require or HttpExecutionStrategies.offloadAll() if offloading for all paths is required (safe default).

Specified by:

requiredOffloads in interface ExecutionStrategyInfluencer<HttpExecutionStrategy>

Specified by:

requiredOffloads in interface HttpExecutionStrategyInfluencer

Returns:

the ExecutionStrategy required by the influencer.

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.