com.lambdaworks.redis.resource

Class Delay

java.lang.Object

com.lambdaworks.redis.resource.Delay

public abstract class Delay
extends Object

Base class for delays and factory class to create particular instances. Delay can be subclassed to create custom delay implementations based on attempts. Attempts start with .

Since:

4.2

Author:

Mark Paluch

Method Summary

Modifier and Type	Method and Description
static Delay	constant(int delay, TimeUnit timeUnit) Creates a new ConstantDelay.
abstract long	createDelay(long attempt) Calculate a specific delay based on the attempt.
static Delay	exponential() Creates a new ExponentialDelay with default boundaries and factor (1, 2, 4, 8, 16, 32...).
static Delay	exponential(long lower, long upper, TimeUnit unit, int powersOf) Creates a new ExponentialDelay on with custom boundaries and factor (eg. with upper 9000, lower 0, powerOf 10: 1, 10, 100, 1000, 9000, 9000, 9000, ...).
TimeUnit	getTimeUnit() Returns the TimeUnit associated with this Delay.

Methods inherited from class java.lang.Object

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

Method Detail

getTimeUnit

public TimeUnit getTimeUnit()

Returns the TimeUnit associated with this Delay.

Returns:

the TimeUnit associated with this Delay.

createDelay

public abstract long createDelay(long attempt)

Calculate a specific delay based on the attempt. This method is to be implemented by the implementations and depending on the params that were set during construction time.

Parameters:

attempt - the attempt to calculate the delay from.

Returns:

the calculated delay.

constant

public static Delay constant(int delay,
                             TimeUnit timeUnit)

Creates a new ConstantDelay.

Parameters:

delay - the delay, must be greater or equal to 0

timeUnit - the unit of the delay.

Returns:

a created ExponentialDelay.

exponential

public static Delay exponential()

Creates a new ExponentialDelay with default boundaries and factor (1, 2, 4, 8, 16, 32...). The delay begins with 1 and is capped at 30 milliseconds after reaching the 16th attempt.

Returns:

a created ExponentialDelay.

exponential

public static Delay exponential(long lower,
                                long upper,
                                TimeUnit unit,
                                int powersOf)

Creates a new ExponentialDelay on with custom boundaries and factor (eg. with upper 9000, lower 0, powerOf 10: 1, 10, 100, 1000, 9000, 9000, 9000, ...).

Parameters:

lower - the lower boundary, must be non-negative

upper - the upper boundary, must be greater than the lower boundary

unit - the unit of the delay.

powersOf - the base for exponential growth (eg. powers of 2, powers of 10, etc...), must be non-negative and greater than 1

Returns:

a created ExponentialDelay.