net.jodah.failsafe

Class Timeout<R>

java.lang.Object

net.jodah.failsafe.PolicyListeners<Timeout<R>,R>

net.jodah.failsafe.Timeout<R>

Type Parameters:

R - result type

All Implemented Interfaces:

Policy<R>

public class Timeout<R>
extends PolicyListeners<Timeout<R>,R>
implements 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 PolicyListeners.onFailure(CheckedConsumer) and PolicyListeners.onSuccess(CheckedConsumer) 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 unkown to Failsafe.

This class is threadsafe.

See Also:

TimeoutExceededException

Method Summary

Modifier and Type	Method and Description
boolean	canCancel() Deprecated. Always returns true
boolean	canInterrupt() Returns whether the policy can interrupt an execution if the timeout is exceeded.
Duration	getTimeout() Returns the timeout duration.
static <R> Timeout<R>	of(Duration timeout) Returns a Timeout that fails an execution with TimeoutExceededException if it exceeds the timeout.
PolicyExecutor	toExecutor(AbstractExecution execution) Returns an PolicyExecutor capable of performing an execution in the context of a Policy and handling results according to the Policy.
Timeout<R>	withCancel(boolean mayInterruptIfRunning) Deprecated. Tasks are cancelled by default when a Timeout is exceeded. Use withInterrupt(boolean) interrupt cancelled tasks when a Timeout is exceeded.
Timeout<R>	withInterrupt(boolean mayInterruptIfRunning) When mayInterruptIfRunning is true, configures the policy to interrupt an execution in addition to cancelling it when the timeout is exceeded.

Methods inherited from class net.jodah.failsafe.PolicyListeners

onFailure, onSuccess

Methods inherited from class java.lang.Object

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

Method Detail

getTimeout

public Duration getTimeout()

Returns the timeout duration.

canCancel

public boolean canCancel()

Deprecated. Always returns true

This method is deprecated and will be removed in a future minor release.

See Also:

withCancel(boolean)

canInterrupt

public boolean canInterrupt()

Returns whether the policy can interrupt an execution if the timeout is exceeded.

See Also:

withInterrupt(boolean)

withCancel

public Timeout<R> withCancel(boolean mayInterruptIfRunning)

Deprecated. Tasks are cancelled by default when a Timeout is exceeded. Use withInterrupt(boolean) interrupt cancelled tasks when a Timeout is exceeded.

This method is deprecated and will be removed in a future minor release.

See Also:

withInterrupt(boolean)

withInterrupt

public Timeout<R> withInterrupt(boolean mayInterruptIfRunning)

When mayInterruptIfRunning is true, configures the policy to interrupt an execution in addition to cancelling it when the timeout is exceeded. For synchronous executions this is done by calling Thread.interrupt() on the execution's thread. For asynchronous executions this is done by calling Future.cancel(true). Executions can internally cooperate with interruption by checking Thread.isInterrupted() or by handling InterruptedException where available.

Note: Only configure interrupts if the code being executed is designed to be interrupted.

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

Parameters:

mayInterruptIfRunning - whether to enable interruption or not

of

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

Returns a Timeout that fails an execution with TimeoutExceededException if it exceeds the timeout.

Parameters:

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

Throws:

NullPointerException - If timeout is null

IllegalArgumentException - If timeout is <= 0

toExecutor

public PolicyExecutor toExecutor(AbstractExecution execution)

Description copied from interface: Policy

Returns an PolicyExecutor capable of performing an execution in the context of a Policy and handling results according to the Policy.

Specified by:

toExecutor in interface Policy<R>