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 fails an excecution with a TimeoutExceededException if it exceeds a timeout. 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: Cancellation and interruption are not supported when performing an async execution and will have no effect 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() Returns whether the policy can cancel an execution if the timeout is exceeded.
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) Configures the policy to cancel an execution if it times out.

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()

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

See Also:

withCancel(boolean)

canInterrupt

public boolean canInterrupt()

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

See Also:

withCancel(boolean)

withCancel

public Timeout<R> withCancel(boolean mayInterruptIfRunning)

Configures the policy to cancel an execution if it times out. Execution cancellation can be observed from within an execution by checking ExecutionContext.isCancelled(), allowing execution to be gracefully stopped. Asynchronous executions are cancelled by calling cancel on their underlying future.

Notes:

• Executions that are cancelled or interrupted after they timeout are still completed with TimeoutExceededException.
• Cancellation and interruption are not supported when performing an async execution and will have no effect since the async thread is unkown to Failsafe.

Parameters:

mayInterruptIfRunning - Whether the policy should interrupt an execution in addition to cancelling it if the timeout is exceeded. When set to true the execution will be interrupted. 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). Only set mayInterruptIfRunning to true if the code being executed is designed to be interrupted.

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>