com.kdgregory.logging.common.util

Class RetryManager

java.lang.Object

com.kdgregory.logging.common.util.RetryManager

Deprecated.

use

@Deprecated
public class RetryManager
extends Object

Invokes a function, retrying with a delay, optionally with exponential backoff. Instances are reusable and thread-safe, so can be created once to define the "standard" retry logic for a given operation.

The function must be a Java8 Supplier, which returns a value. Use a lambda to wrap calls that don't return a value (to retry operations that may throw a non-fatal exception).

Constructor Summary

Constructors

Constructor and Description
RetryManager(Duration initialDuration, Duration timeout, boolean isExponential) Deprecated. Constructor for those preferring Java8 durations.
RetryManager(long initialDuration, long timeout, boolean isExponential) Deprecated. Constructor for those who like to specify times in milliseconds.

Method Summary

Modifier and Type	Method and Description
<T> T	invoke(Supplier<T> supplier) Deprecated. Invokes the passed function.
<T> T	invoke(Supplier<T> supplier, Consumer<RuntimeException> exceptionHandler) Deprecated. Invokes the passed function.
static boolean	sleepQuietly(long duration) Deprecated. Sleeps for the specified duration (in milliseconds).

Methods inherited from class java.lang.Object

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

Constructor Detail

RetryManager

public RetryManager(long initialDuration,
                    long timeout,
                    boolean isExponential)

Deprecated.

Constructor for those who like to specify times in milliseconds.

Parameters:

initialDuration - The initial time, in milliseconds, to wait between calls.

timeout - The maximum time, in milliseconds, to attempt calls. The number of calls attempted will depend on initialDuration and the wait strategy.

isExponential - If true, then the sleep duration is doubled for every attempt. If false, the sleeps are of equal length.

RetryManager

public RetryManager(Duration initialDuration,
                    Duration timeout,
                    boolean isExponential)

Deprecated.

Constructor for those preferring Java8 durations.

Parameters:

initialDuration - The initial time to wait between calls.

timeout - The maximum time to attempt calls. The number of calls attempted will depend on initialDuration and the wait strategy.

isExponential - If true, then the sleep duration is doubled for every attempt.

Method Detail

invoke

public <T> T invoke(Supplier<T> supplier)

Deprecated.

Invokes the passed function. If it returns a non-null result, that result is returned to the caller. If it returns null, it is retried after sleep. After the timeout expires, this method returns null. All exceptions are propagated.

If the thread is interrupted, this method terminates and returns null.

invoke

public <T> T invoke(Supplier<T> supplier,
                    Consumer<RuntimeException> exceptionHandler)

Deprecated.

Invokes the passed function. If it returns a non-null result, that result is returned to the caller. If it returns null, it is retried after sleep. After the timeout expires, this method returns null. Exceptions are caught and passed to the handler, which can either return (to sleep and retry) or throw. Note that the handler only accepts subclasses of RuntimeException, since Supplier is not permitted to throw arbitrary exceptions.

If the thread is interrupted, this method terminates and returns null.

sleepQuietly

public static boolean sleepQuietly(long duration)

Deprecated.

Sleeps for the specified duration (in milliseconds). Returns true if the sleep completes normally, false if the thread is interrupted.