Class ExponentialBackoffPolicy

java.lang.Object

io.spiffe.workloadapi.retry.ExponentialBackoffPolicy

public class ExponentialBackoffPolicy
extends Object

Represents a backoff policy for performing retries using exponential increasing delays.

Field Summary

Fields

Modifier and Type	Field	Description
static final ExponentialBackoffPolicy	DEFAULT
static final int	UNLIMITED_RETRIES

Constructor Summary

Constructors

Constructor	Description
ExponentialBackoffPolicy(Duration initialDelay, Duration maxDelay, int maxRetries, int backoffMultiplier)

Method Summary

Modifier and Type	Method	Description
Duration	nextDelay(Duration currentDelay)	Calculate the nextDelay based on a currentDelay, applying the backoff function If the calculated delay is greater than maxDelay, it returns maxDelay.
boolean	reachedMaxRetries(int retriesCount)	Returns false if the RetryPolicy is configured with UNLIMITED_RETRIES or if the retriesCount param is lower than the maxRetries.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

public static final ExponentialBackoffPolicy DEFAULT

UNLIMITED_RETRIES

public static final int UNLIMITED_RETRIES

See Also:

• Constant Field Values

Constructor Details

ExponentialBackoffPolicy

public ExponentialBackoffPolicy(Duration initialDelay,
 Duration maxDelay,
 int maxRetries,
 int backoffMultiplier)

Method Details

nextDelay

public Duration nextDelay(Duration currentDelay)

Calculate the nextDelay based on a currentDelay, applying the backoff function If the calculated delay is greater than maxDelay, it returns maxDelay.

Parameters:

currentDelay - a Duration representing the current delay

Returns:

a Duration representing the next delay

reachedMaxRetries

public boolean reachedMaxRetries(int retriesCount)

Returns false if the RetryPolicy is configured with UNLIMITED_RETRIES or if the retriesCount param is lower than the maxRetries.

Parameters:

retriesCount - the current number of retries

Returns:

true if the number of retries reached the max number of retries, false otherwise