Package dev.failsafe

Interface Timeout<R>

Type Parameters:

R - result type

All Superinterfaces:

Policy<R>

All Known Implementing Classes:

TimeoutImpl

public interface Timeout<R>
extends Policy<R>

A policy that cancels and fails an excecution with a TimeoutExceededException if a timeout is exceeded. Execution interruption is optionally supported. Asynchronous executions are cancelled by calling cancel on their underlying future. Executions can internally cooperate with cancellation by checking ExecutionContext.isCancelled().

This policy uses a separate thread on the configured scheduler or the common pool to perform timeouts checks.

The PolicyBuilder.onFailure(EventListener) and PolicyBuilder.onSuccess(EventListener) event handlers can be used to handle a timeout being exceeded or not.

Note: interruption will have no effect when performing an async execution since the async thread is unknown to Failsafe.

This class is threadsafe.

See Also:

• TimeoutConfig
• TimeoutBuilder
• TimeoutExceededException

Method Summary

Modifier and Type	Method	Description
static <R> TimeoutBuilder<R>	builder(TimeoutConfig<R> config)	Creates a new TimeoutBuilder that will be based on the config.
static <R> TimeoutBuilder<R>	builder(Duration timeout)	Returns a TimeoutBuilder that builds Timeout instances with the given timeout.
TimeoutConfig<R>	getConfig()	Returns the TimeoutConfig that the Timeout was built with.
static <R> Timeout<R>	of(Duration timeout)	Returns a Timeout that fails an execution with TimeoutExceededException if it exceeds the timeout.

Methods inherited from interface dev.failsafe.Policy

toExecutor

Method Details

builder

static <R> TimeoutBuilder<R> builder(Duration timeout)

Returns a TimeoutBuilder that builds Timeout instances with the given timeout.

Parameters:

timeout - the duration after which an execution is failed with TimeoutExceededException.

Throws:

NullPointerException - If timeout is null

IllegalArgumentException - If timeout is invalid input: '<'= 0

builder

static <R> TimeoutBuilder<R> builder(TimeoutConfig<R> config)

Creates a new TimeoutBuilder that will be based on the config.

of

static <R> Timeout<R> of(Duration timeout)

Returns a Timeout that fails an execution with TimeoutExceededException if it exceeds the timeout. Alias for Timeout.builder(timeout).build(). To configure additional options on a Timeout, use builder(Duration) instead.

Type Parameters:

R - result type

Parameters:

timeout - the duration after which an execution is failed with TimeoutExceededException.

Throws:

NullPointerException - If timeout is null

IllegalArgumentException - If timeout is invalid input: '<'= 0

See Also:

• builder(Duration)

getConfig

TimeoutConfig<R> getConfig()

Returns the TimeoutConfig that the Timeout was built with.

Specified by:

getConfig in interface Policy<R>