io.servicetalk.concurrent.api

Class RepeatStrategies

Object

RepeatStrategies

public final class RepeatStrategies
extends Object

A set of strategies to use for repeating with Publisher.repeatWhen(IntFunction), Single.repeatWhen(IntFunction) and Completable.repeatWhen(IntFunction) or in general.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RepeatStrategies.TerminateRepeatException An Exception instance used to indicate termination of repeats.

Method Summary

Modifier and Type	Method and Description
static IntFunction<Completable>	repeatWithConstantBackoff(int maxRepeats, Duration backoff, Executor timerExecutor) Creates a new repeat function that adds the passed constant Duration as delay between repeats.
static IntFunction<Completable>	repeatWithExponentialBackoff(int maxRepeats, Duration initialDelay, Executor timerExecutor) Creates a new repeat function that adds a delay between repeats.
static IntFunction<Completable>	repeatWithExponentialBackoffAndJitter(int maxRepeats, Duration initialDelay, Executor timerExecutor) Creates a new repeat function that adds a delay between repeats.

Methods inherited from class Object

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

Method Detail

repeatWithConstantBackoff

public static IntFunction<Completable> repeatWithConstantBackoff(int maxRepeats,
                                                                 Duration backoff,
                                                                 Executor timerExecutor)

Creates a new repeat function that adds the passed constant Duration as delay between repeats.

Parameters:

maxRepeats - Maximum number of allowed repeats, after which the returned IntFunction will return a failed Completable with RepeatStrategies.TerminateRepeatException as the cause.

backoff - Constant Duration of backoff between repeats.

timerExecutor - Executor to be used to schedule timers for backoff.

Returns:

An IntFunction to be used for repeats which given a repeat count returns a Completable that terminates successfully when the source has to be repeated or terminates with error if the source should not be repeated.

repeatWithExponentialBackoff

public static IntFunction<Completable> repeatWithExponentialBackoff(int maxRepeats,
                                                                    Duration initialDelay,
                                                                    Executor timerExecutor)

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

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

Parameters:

maxRepeats - Maximum number of allowed repeats, after which the returned IntFunction will return a failed Completable with RepeatStrategies.TerminateRepeatException as the cause.

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

timerExecutor - Executor to be used to schedule timers for backoff.

Returns:

An IntFunction to be used for repeats which given a repeat count returns a Completable that terminates successfully when the source has to be repeated or terminates with error if the source should not be repeated.

repeatWithExponentialBackoffAndJitter

public static IntFunction<Completable> repeatWithExponentialBackoffAndJitter(int maxRepeats,
                                                                             Duration initialDelay,
                                                                             Executor timerExecutor)

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

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

Parameters:

maxRepeats - Maximum number of allowed repeats, after which the returned IntFunction will return a failed Completable with RepeatStrategies.TerminateRepeatException as the cause.

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

timerExecutor - Executor to be used to schedule timers for backoff.

Returns:

An IntFunction to be used for repeats which given a repeat count returns a Completable that terminates successfully when the source has to be repeated or terminates with error if the source should not be repeated.