Package ch.powerunit.extensions.async.lang

Class RetryPolicies

java.lang.Object

ch.powerunit.extensions.async.lang.RetryPolicies

public final class RetryPolicies
extends Object

Helpers methods to build RetryPolicy.

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static RetryPolicy	RETRY_ONLY_ONCE	Retry Policy to just do one try.

Method Summary

Modifier and Type	Method	Description
static RetryPolicy	of(int count, long ms)	Create a new RetryPolicy with constant wait time.
static RetryPolicy	of(int count, long value, TimeUnit unit)	Create a new RetryPolicy with constant wait time.
static RetryPolicy	of(int count, Duration duration)	Create a new RetryPolicy with constant wait time.
static RetryPolicy	of(int count, IntToLongFunction retryToWaitTime)	Create a new RetryPolicy, by using a generic function to compute the retry duration.
static RetryPolicy	ofIncremental(int count, long ms)	Create a new RetryPolicy, that wait each time more time : first time the received duration, second time twice, etc.
static RetryPolicy	ofIncremental(int count, Duration duration)	Create a new RetryPolicy, that wait each time more time : first time the received duration, second time twice, etc.

Methods inherited from class java.lang.Object

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

Field Detail

RETRY_ONLY_ONCE

public static final RetryPolicy RETRY_ONLY_ONCE

Retry Policy to just do one try.

Method Detail

of

public static RetryPolicy of(int count,
                             long ms)

Create a new RetryPolicy with constant wait time.

For example,

 RetryPolicy incremental = RetryPolicies.of(3, 12);
 

Then following of (re-)tries will be (maximum retries):

1. Do a first try
2. Wait 12 ms
3. Do a second retry
4. Wait 12 ms
5. Do a third retry

Parameters:

count - the number of retry.

ms - the constant wait time in ms.

Returns:

the RetryPolicy

of

public static RetryPolicy of(int count,
                             long value,
                             TimeUnit unit)

Create a new RetryPolicy with constant wait time.

For example,

 RetryPolicy incremental = RetryPolicies.of(3, 15, TimeUnit.MILLISECONDS);
 

Then following of (re-)tries will be (maximum retries):

1. Do a first try
2. Wait 15 ms
3. Do a second retry
4. Wait 15 ms
5. Do a third retry

Parameters:

count - the number of retry.

value - the wait time

unit - the unit of the wait time.

Returns:

the RetryPolicy

of

public static RetryPolicy of(int count,
                             Duration duration)

Create a new RetryPolicy with constant wait time.

For example,

 RetryPolicy incremental = RetryPolicies.of(3, Duration.ofMillis(10));
 

Then following of (re-)tries will be (maximum retries):

1. Do a first try
2. Wait 10 ms
3. Do a second retry
4. Wait 10 ms
5. Do a third retry

Parameters:

count - the number of retry.

duration - the constant duration to wait.

Returns:

the RetryPolicy

of

public static RetryPolicy of(int count,
                             IntToLongFunction retryToWaitTime)

Create a new RetryPolicy, by using a generic function to compute the retry duration.

For example, using this definition :

 RetryPolicy incremental = RetryPolicies.of(3, c -> (long) (Math.random() * 100));
 

Then following of (re-)tries will be (maximum retries):

1. Do a first try
2. Wait a random time between 0 and 100 ms
3. Do a second retry
4. Wait a random time between 0 and 100 ms
5. Do a third retry

Parameters:

count - the number of retry. A value of 1 is to do only one try, without sleep.

retryToWaitTime - the function to compute the wait time based on the retry. The received value by this function starts with 1, and this will be the first retry (meaning a the initial try has been done before).

Returns:

the RetryPolicy

ofIncremental

public static RetryPolicy ofIncremental(int count,
                                        long ms)

Create a new RetryPolicy, that wait each time more time : first time the received duration, second time twice, etc.

For example, using this definition :

 RetryPolicy incremental = RetryPolicies.ofIncremental(3, 20);
 

Then following of (re-)tries will be (maximum retries):

1. Do a first try
2. Wait 20ms
3. Do a second retry
4. Wait 40ms
5. Do a third retry

Parameters:

count - the number of retry.

ms - the time in ms that will be combined with the retry number

Returns:

the RetryPolicy

ofIncremental

public static RetryPolicy ofIncremental(int count,
                                        Duration duration)

Create a new RetryPolicy, that wait each time more time : first time the received duration, second time twice, etc.

For example, using this definition :

 RetryPolicy incremental = RetryPolicies.ofIncremental(3, Duration.ofMillis(50));
 

Then following of (re-)tries will be (maximum retries):

1. Do a first try
2. Wait 50ms
3. Do a second retry
4. Wait 100ms
5. Do a third retry

Parameters:

count - the number of retry.

duration - the duration that will be combined with the retry number

Returns:

the RetryPolicy