cn.aotcloud.retry

类 Retryer<V>

java.lang.Object

cn.aotcloud.retry.Retryer<V>

类型参数:

V - the type of the call return value

public final class Retryer<V>
extends Object

A retryer, which executes a call, and retries it until it succeeds, or a stop strategy decides to stop retrying. A wait strategy is used to sleep between attempts. The strategy to decide if the call succeeds or not is also configurable.

A retryer can also wrap the callable into a RetryerCallable, which can be submitted to an executor.

Retryer instances are better constructed with a RetryerBuilder. A retryer is thread-safe, provided the arguments passed to its constructor are thread-safe.

作者:

JB, Jason Dunkelberger (dirkraft)

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	Retryer.RetryerCallable<X> A Callable which wraps another Callable in order to add retrying behavior from a given Retryer instance.

构造器概要

构造器

构造器和说明
Retryer(AttemptTimeLimiter<V> attemptTimeLimiter, StopStrategy stopStrategy, WaitStrategy waitStrategy, BlockStrategy blockStrategy, com.google.common.base.Predicate<Attempt<V>> rejectionPredicate) Constructor
Retryer(AttemptTimeLimiter<V> attemptTimeLimiter, StopStrategy stopStrategy, WaitStrategy waitStrategy, BlockStrategy blockStrategy, com.google.common.base.Predicate<Attempt<V>> rejectionPredicate, Collection<RetryListener> listeners) Constructor
Retryer(AttemptTimeLimiter<V> attemptTimeLimiter, StopStrategy stopStrategy, WaitStrategy waitStrategy, com.google.common.base.Predicate<Attempt<V>> rejectionPredicate) Constructor
Retryer(StopStrategy stopStrategy, WaitStrategy waitStrategy, com.google.common.base.Predicate<Attempt<V>> rejectionPredicate) Constructor

方法概要

限定符和类型	方法和说明
V	call(Callable<V> callable) Executes the given callable.
Retryer.RetryerCallable<V>	wrap(Callable<V> callable) Wraps the given Callable in a Retryer.RetryerCallable, which can be submitted to an executor.

从类继承的方法 java.lang.Object

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

构造器详细资料

Retryer

public Retryer(@Nonnull
               StopStrategy stopStrategy,
               @Nonnull
               WaitStrategy waitStrategy,
               @Nonnull
               com.google.common.base.Predicate<Attempt<V>> rejectionPredicate)

Constructor

参数:

stopStrategy - the strategy used to decide when the retryer must stop retrying

waitStrategy - the strategy used to decide how much time to sleep between attempts

rejectionPredicate - the predicate used to decide if the attempt must be rejected or not. If an attempt is rejected, the retryer will retry the call, unless the stop strategy indicates otherwise or the thread is interrupted.

Retryer

public Retryer(@Nonnull
               AttemptTimeLimiter<V> attemptTimeLimiter,
               @Nonnull
               StopStrategy stopStrategy,
               @Nonnull
               WaitStrategy waitStrategy,
               @Nonnull
               com.google.common.base.Predicate<Attempt<V>> rejectionPredicate)

Constructor

参数:

attemptTimeLimiter - to prevent from any single attempt from spinning infinitely

stopStrategy - the strategy used to decide when the retryer must stop retrying

waitStrategy - the strategy used to decide how much time to sleep between attempts

rejectionPredicate - the predicate used to decide if the attempt must be rejected or not. If an attempt is rejected, the retryer will retry the call, unless the stop strategy indicates otherwise or the thread is interrupted.

Retryer

public Retryer(@Nonnull
               AttemptTimeLimiter<V> attemptTimeLimiter,
               @Nonnull
               StopStrategy stopStrategy,
               @Nonnull
               WaitStrategy waitStrategy,
               @Nonnull
               BlockStrategy blockStrategy,
               @Nonnull
               com.google.common.base.Predicate<Attempt<V>> rejectionPredicate)

Constructor

参数:

attemptTimeLimiter - to prevent from any single attempt from spinning infinitely

stopStrategy - the strategy used to decide when the retryer must stop retrying

waitStrategy - the strategy used to decide how much time to sleep between attempts

blockStrategy - the strategy used to decide how to block between retry attempts; eg, Thread#sleep(), latches, etc.

rejectionPredicate - the predicate used to decide if the attempt must be rejected or not. If an attempt is rejected, the retryer will retry the call, unless the stop strategy indicates otherwise or the thread is interrupted.

Retryer

@Beta
public Retryer(@Nonnull
                      AttemptTimeLimiter<V> attemptTimeLimiter,
                      @Nonnull
                      StopStrategy stopStrategy,
                      @Nonnull
                      WaitStrategy waitStrategy,
                      @Nonnull
                      BlockStrategy blockStrategy,
                      @Nonnull
                      com.google.common.base.Predicate<Attempt<V>> rejectionPredicate,
                      @Nonnull
                      Collection<RetryListener> listeners)

Constructor

参数:

attemptTimeLimiter - to prevent from any single attempt from spinning infinitely

stopStrategy - the strategy used to decide when the retryer must stop retrying

waitStrategy - the strategy used to decide how much time to sleep between attempts

blockStrategy - the strategy used to decide how to block between retry attempts; eg, Thread#sleep(), latches, etc.

rejectionPredicate - the predicate used to decide if the attempt must be rejected or not. If an attempt is rejected, the retryer will retry the call, unless the stop strategy indicates otherwise or the thread is interrupted.

listeners - collection of retry listeners

方法详细资料

call

public V call(Callable<V> callable)
       throws ExecutionException,
              RetryException

Executes the given callable. If the rejection predicate accepts the attempt, the stop strategy is used to decide if a new attempt must be made. Then the wait strategy is used to decide how much time to sleep and a new attempt is made.

参数:

callable - the callable task to be executed

返回:

the computed result of the given callable

抛出:

ExecutionException - if the given callable throws an exception, and the rejection predicate considers the attempt as successful. The original exception is wrapped into an ExecutionException.

RetryException - if all the attempts failed before the stop strategy decided to abort, or the thread was interrupted. Note that if the thread is interrupted, this exception is thrown and the thread's interrupt status is set.

wrap

public Retryer.RetryerCallable<V> wrap(Callable<V> callable)

Wraps the given Callable in a Retryer.RetryerCallable, which can be submitted to an executor. The returned Retryer.RetryerCallable uses this Retryer instance to call the given Callable.

参数:

callable - the callable to wrap

返回:

a Retryer.RetryerCallable that behaves like the given Callable with retry behavior defined by this Retryer