io.servicetalk.concurrent.api

Class RetryStrategies

java.lang.Object

io.servicetalk.concurrent.api.RetryStrategies

public final class RetryStrategies
extends java.lang.Object

A set of strategies to use for retrying with Publisher.retryWhen(BiIntFunction), Single.retryWhen(BiIntFunction), and Completable.retryWhen(BiIntFunction) or in general.

Method Summary

Modifier and Type	Method and Description
static BiIntFunction<java.lang.Throwable,Completable>	retryWithConstantBackoff(int maxRetries, java.util.function.Predicate<java.lang.Throwable> causeFilter, java.time.Duration delay, Executor timerExecutor) Creates a new retry function that adds the passed constant Duration as a delay between retries.
static BiIntFunction<java.lang.Throwable,Completable>	retryWithConstantBackoffAndJitter(int maxRetries, java.util.function.Predicate<java.lang.Throwable> causeFilter, java.time.Duration delay, Executor timerExecutor) Creates a new retry function that adds the passed constant Duration as a delay between retries.
static BiIntFunction<java.lang.Throwable,Completable>	retryWithExponentialBackoff(int maxRetries, java.util.function.Predicate<java.lang.Throwable> causeFilter, java.time.Duration initialDelay, Executor timerExecutor) Creates a new retry function that adds a delay between retries.
static BiIntFunction<java.lang.Throwable,Completable>	retryWithExponentialBackoffAndJitter(int maxRetries, java.util.function.Predicate<java.lang.Throwable> causeFilter, java.time.Duration initialDelay, Executor timerExecutor) Creates a new retry function that adds a delay between retries.

Methods inherited from class java.lang.Object

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

Method Detail

retryWithConstantBackoff

public static BiIntFunction<java.lang.Throwable,Completable> retryWithConstantBackoff(int maxRetries,
                                                                                      java.util.function.Predicate<java.lang.Throwable> causeFilter,
                                                                                      java.time.Duration delay,
                                                                                      Executor timerExecutor)

Creates a new retry function that adds the passed constant Duration as a delay between retries.

Parameters:

maxRetries - Maximum number of allowed retries, after which the returned BiIntFunction will return a failed Completable with the passed Throwable as the cause

causeFilter - A Predicate that selects whether a Throwable cause should be retried

delay - Constant Duration of delay between retries

timerExecutor - Executor to be used to schedule timers for backoff

Returns:

A BiIntFunction to be used for retries which given a retry count and a Throwable returns a Completable that terminates successfully when the source has to be retried or terminates with error if the source should not be retried for the passed Throwable

retryWithConstantBackoffAndJitter

public static BiIntFunction<java.lang.Throwable,Completable> retryWithConstantBackoffAndJitter(int maxRetries,
                                                                                               java.util.function.Predicate<java.lang.Throwable> causeFilter,
                                                                                               java.time.Duration delay,
                                                                                               Executor timerExecutor)

Creates a new retry function that adds the passed constant Duration as a delay between retries. This additionally adds a "Full Jitter" for the backoff as described here.

Parameters:

maxRetries - Maximum number of allowed retries, after which the returned BiIntFunction will return a failed Completable with the passed Throwable as the cause

causeFilter - A Predicate that selects whether a Throwable cause should be retried

delay - Constant Duration of delay between retries

timerExecutor - Executor to be used to schedule timers for backoff

Returns:

A BiIntFunction to be used for retries which given a retry count and a Throwable returns a Completable that terminates successfully when the source has to be retried or terminates with error if the source should not be retried for the passed Throwable

retryWithExponentialBackoff

public static BiIntFunction<java.lang.Throwable,Completable> retryWithExponentialBackoff(int maxRetries,
                                                                                         java.util.function.Predicate<java.lang.Throwable> causeFilter,
                                                                                         java.time.Duration initialDelay,
                                                                                         Executor timerExecutor)

Creates a new retry function that adds a delay between retries. For first retry, the delay is initialDelay which is increased exponentially for subsequent retries.

This method may not attempt to check for overflow if the retry count is high enough that an exponential delay causes Long overflow.

Parameters:

maxRetries - Maximum number of allowed retries, after which the returned BiIntFunction will return a failed Completable with the passed Throwable as the cause

causeFilter - A Predicate that selects whether a Throwable cause should be retried

initialDelay - Delay Duration for the first retry and increased exponentially with each retry

timerExecutor - Executor to be used to schedule timers for backoff

Returns:

A BiIntFunction to be used for retries which given a retry count and a Throwable returns a Completable that terminates successfully when the source has to be retried or terminates with error if the source should not be retried for the passed Throwable

retryWithExponentialBackoffAndJitter

public static BiIntFunction<java.lang.Throwable,Completable> retryWithExponentialBackoffAndJitter(int maxRetries,
                                                                                                  java.util.function.Predicate<java.lang.Throwable> causeFilter,
                                                                                                  java.time.Duration initialDelay,
                                                                                                  Executor timerExecutor)

Creates a new retry function that adds a delay between retries. For first retry, the delay is initialDelay which is increased exponentially for subsequent retries. This additionally adds a "Full Jitter" for the backoff as described here.

This method may not attempt to check for overflow if the retry count is high enough that an exponential delay causes Long overflow.

Parameters:

maxRetries - Maximum number of allowed retries, after which the returned BiIntFunction will return a failed Completable with the passed Throwable as the cause

causeFilter - A Predicate that selects whether a Throwable cause should be retried

initialDelay - Delay Duration for the first retry and increased exponentially with each retry

timerExecutor - Executor to be used to schedule timers for backoff

Returns:

A BiIntFunction to be used for retries which given a retry count and a Throwable returns a Completable that terminates successfully when the source has to be retried or terminates with error if the source should not be retried for the passed Throwable