org.spf4j.base

Class Callables

java.lang.Object

org.spf4j.base.Callables

@ParametersAreNonnullByDefault
public final class Callables
extends Object

Utility class for executing stuff with retry logic.

Author:

zoly

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Callables.PreRetryCallback<T>
static class	Callables.RetryPauseWithTimeout<T>
static class	Callables.TimeoutCallable<T>

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.common.base.Predicate<Exception>	DEFAULT_EXCEPTION_RETRY
static com.google.common.base.Predicate<Object>	NORETRY_FOR_RESULT
static com.google.common.base.Predicate<?>	RETRY_FOR_NULL_RESULT

Method Summary

Methods

Modifier and Type	Method and Description
static <T> Callables.PreRetryCallback<T>	callableToPreRetryCallback(Callable<Boolean> doBeforeRetry)
static <T> T	executeWithRetry(Callable<T> what, Callable<Boolean> doBeforeRetry, com.google.common.base.Predicate<? super T> retryOnReturnVal, com.google.common.base.Predicate<Exception> retryOnException)
static <T> T	executeWithRetry(Callable<T> what, Callables.PreRetryCallback<T> doBeforeRetry, com.google.common.base.Predicate<? super T> retryOnReturnVal, com.google.common.base.Predicate<Exception> retryOnException) Naive implementation of execution with retry logic.
static <T> T	executeWithRetry(Callables.TimeoutCallable<T> what, Callables.PreRetryCallback<T> doBeforeRetry, int nrImmediateRetries, int maxWaitMillis, com.google.common.base.Predicate<? super T> retryOnReturnVal, com.google.common.base.Predicate<Exception> retryOnException) After the immediate retries are done, delayed retry with randomized Fibonacci values up to the specified max is executed.
static <T> T	executeWithRetry(Callables.TimeoutCallable<T> what, int nrImmediateRetries, int maxRetryWaitMillis)
static <T> T	executeWithRetry(Callables.TimeoutCallable<T> what, int nrImmediateRetries, int maxRetryWaitMillis, com.google.common.base.Predicate<? super T> retryOnReturnVal, com.google.common.base.Predicate<Exception> retryOnException)
static <T> T	executeWithRetry(Callables.TimeoutCallable<T> what, int nrImmediateRetries, int maxRetryWaitMillis, com.google.common.base.Predicate<Exception> retryOnException)
static <T> Callable<T>	synchronize(Callable<T> callable)

Methods inherited from class java.lang.Object

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

Field Detail

NORETRY_FOR_RESULT

public static final com.google.common.base.Predicate<Object> NORETRY_FOR_RESULT

RETRY_FOR_NULL_RESULT

public static final com.google.common.base.Predicate<?> RETRY_FOR_NULL_RESULT

DEFAULT_EXCEPTION_RETRY

public static final com.google.common.base.Predicate<Exception> DEFAULT_EXCEPTION_RETRY

Method Detail

executeWithRetry

public static <T> T executeWithRetry(Callables.TimeoutCallable<T> what,
                     int nrImmediateRetries,
                     int maxRetryWaitMillis)
                          throws InterruptedException

Throws:

InterruptedException

executeWithRetry

public static <T> T executeWithRetry(Callables.TimeoutCallable<T> what,
                     int nrImmediateRetries,
                     int maxRetryWaitMillis,
                     com.google.common.base.Predicate<Exception> retryOnException)
                          throws InterruptedException

Throws:

InterruptedException

executeWithRetry

public static <T> T executeWithRetry(Callables.TimeoutCallable<T> what,
                     int nrImmediateRetries,
                     int maxRetryWaitMillis,
                     com.google.common.base.Predicate<? super T> retryOnReturnVal,
                     com.google.common.base.Predicate<Exception> retryOnException)
                          throws InterruptedException

Throws:

InterruptedException

executeWithRetry

public static <T> T executeWithRetry(Callables.TimeoutCallable<T> what,
                     Callables.PreRetryCallback<T> doBeforeRetry,
                     int nrImmediateRetries,
                     int maxWaitMillis,
                     com.google.common.base.Predicate<? super T> retryOnReturnVal,
                     com.google.common.base.Predicate<Exception> retryOnException)
                          throws InterruptedException

After the immediate retries are done, delayed retry with randomized Fibonacci values up to the specified max is executed.

Type Parameters:

T -

Parameters:

what -

doBeforeRetry -

nrImmediateRetries -

maxWaitMillis -

retryOnReturnVal -

retryOnException -

Returns:

Throws:

InterruptedException

executeWithRetry

public static <T> T executeWithRetry(Callable<T> what,
                     Callable<Boolean> doBeforeRetry,
                     com.google.common.base.Predicate<? super T> retryOnReturnVal,
                     com.google.common.base.Predicate<Exception> retryOnException)
                          throws InterruptedException

Throws:

InterruptedException

callableToPreRetryCallback

public static <T> Callables.PreRetryCallback<T> callableToPreRetryCallback(Callable<Boolean> doBeforeRetry)

executeWithRetry

public static <T> T executeWithRetry(Callable<T> what,
                     Callables.PreRetryCallback<T> doBeforeRetry,
                     com.google.common.base.Predicate<? super T> retryOnReturnVal,
                     com.google.common.base.Predicate<Exception> retryOnException)
                          throws InterruptedException

Naive implementation of execution with retry logic. a callable will be executed and retry attempted in current thread if the result and exception predicates. before retry, a callable can be executed that can abort the retry and finish the function with the previous result.

Parameters:

what -

doBeforeRetry -

retryOnReturnVal -

retryOnException -

Returns:

Throws:

InterruptedException

synchronize

public static <T> Callable<T> synchronize(Callable<T> callable)