net.jodah.failsafe.function

Interface DelayFunction<R,F extends Throwable>

Type Parameters:

R - result type

F - failure type

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface DelayFunction<R,F extends Throwable>

A functional interface for computing delays between Policy execution attempts.

Method Summary

Modifier and Type	Method and Description
Duration	computeDelay(R result, F failure, ExecutionContext context) Returns the amount of delay before the next Policy execution attempt based on the result or failure of the last attempt and the execution context (executions so far).

Method Detail

computeDelay

Duration computeDelay(R result,
                      F failure,
                      ExecutionContext context)

Returns the amount of delay before the next Policy execution attempt based on the result or failure of the last attempt and the execution context (executions so far). This method must complete quickly, not have side-effects, and always return the same result for the same input. Unchecked exceptions thrown by this method will not be treated as part of the fail-safe processing and will instead abort that processing.

Notes:

• A negative return value will cause Failsafe to use a configured fixed or backoff delay
• Any configured jitter is still applied to DelayFunction provided values
• Any configured max duration is still applied to DelayFunction provided values

Parameters:

result - the result, if any, of the last attempt

failure - the Throwable thrown, if any, during the last attempt

context - the ExecutionContext that describes executions so far. May be null if the execution failure was manually recorded outside of a Failsafe execution.

Returns:

a non-negative duration to be used as the delay before next execution attempt, otherwise (null or negative duration) means fall back to the otherwise configured delay