Package io.servicetalk.http.netty

Class RetryingHttpRequesterFilter.BackOffPolicy

java.lang.Object

io.servicetalk.http.netty.RetryingHttpRequesterFilter.BackOffPolicy

Enclosing class:

RetryingHttpRequesterFilter

public static final class RetryingHttpRequesterFilter.BackOffPolicy
extends Object

Definition and presets of retry backoff policies.

Field Summary

Fields

Modifier and Type	Field	Description
static final RetryingHttpRequesterFilter.BackOffPolicy	NO_RETRIES	Deprecated. This will be removed in a future release of ST.

Method Summary

Modifier and Type	Method	Description
BiIntFunction<Throwable,Completable>	newStrategy(Executor alternativeTimerExecutor)	Builds a new retry strategy BiIntFunction for retrying with Publisher.retryWhen(BiIntFunction), Single.retryWhen(BiIntFunction), and Completable.retryWhen(BiIntFunction) or in general with an alternative timer Executor.
static RetryingHttpRequesterFilter.BackOffPolicy	ofConstantBackoffDeltaJitter(Duration delay, Duration jitter, int maxRetries)	Creates a new retrying RetryingHttpRequesterFilter.BackOffPolicy which adds a randomized delay between retries and uses the passed Duration as a maximum delay possible.
static RetryingHttpRequesterFilter.BackOffPolicy	ofConstantBackoffDeltaJitter(Duration delay, Duration jitter, Executor timerExecutor, int maxRetries)	Creates a new retrying RetryingHttpRequesterFilter.BackOffPolicy which adds a randomized delay between retries and uses the passed Duration as a maximum delay possible.
static RetryingHttpRequesterFilter.BackOffPolicy	ofConstantBackoffFullJitter(Duration delay, int maxRetries)	Creates a new retrying RetryingHttpRequesterFilter.BackOffPolicy which adds a randomized delay between retries and uses the passed Duration as a maximum delay possible.
static RetryingHttpRequesterFilter.BackOffPolicy	ofConstantBackoffFullJitter(Duration delay, int maxRetries, Executor timerExecutor)	Creates a new retrying RetryingHttpRequesterFilter.BackOffPolicy which adds a randomized delay between retries and uses the passed Duration as a maximum delay possible.
static RetryingHttpRequesterFilter.BackOffPolicy	ofExponentialBackoffDeltaJitter(Duration initialDelay, Duration jitter, Duration maxDelay, int maxRetries)	Creates a new retrying RetryingHttpRequesterFilter.BackOffPolicy which adds a delay between retries.
static RetryingHttpRequesterFilter.BackOffPolicy	ofExponentialBackoffDeltaJitter(Duration initialDelay, Duration jitter, Duration maxDelay, int maxRetries, Executor timerExecutor)	Creates a new retrying RetryingHttpRequesterFilter.BackOffPolicy which adds a delay between retries.
static RetryingHttpRequesterFilter.BackOffPolicy	ofExponentialBackoffFullJitter(Duration initialDelay, Duration maxDelay, int maxRetries)	Creates a new retrying RetryingHttpRequesterFilter.BackOffPolicy which adds a delay between retries.
static RetryingHttpRequesterFilter.BackOffPolicy	ofExponentialBackoffFullJitter(Duration initialDelay, Duration maxDelay, int maxRetries, Executor timerExecutor)	Creates a new retrying RetryingHttpRequesterFilter.BackOffPolicy which adds a delay between retries.
static RetryingHttpRequesterFilter.BackOffPolicy	ofImmediate()	Deprecated. Use ofImmediateBounded().
static RetryingHttpRequesterFilter.BackOffPolicy	ofImmediate(int maxRetries)	Creates a new RetryingHttpRequesterFilter.BackOffPolicy that retries failures instantly up-to provided max retries.
static RetryingHttpRequesterFilter.BackOffPolicy	ofImmediateBounded()	Creates a new RetryingHttpRequesterFilter.BackOffPolicy that retries failures instantly up-to 3 max retries.
static RetryingHttpRequesterFilter.BackOffPolicy	ofNoRetries()	Special RetryingHttpRequesterFilter.BackOffPolicy that signals that no retries will be attempted.

Methods inherited from class java.lang.Object

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

Field Details

NO_RETRIES

@Deprecated
public static final RetryingHttpRequesterFilter.BackOffPolicy NO_RETRIES

Deprecated.

This will be removed in a future release of ST. Alternative offering here ofNoRetries().

Special RetryingHttpRequesterFilter.BackOffPolicy to signal no retries.

Method Details

ofImmediate

@Deprecated
public static RetryingHttpRequesterFilter.BackOffPolicy ofImmediate()

Deprecated.

Use ofImmediateBounded().

Creates a new RetryingHttpRequesterFilter.BackOffPolicy that retries failures instantly up-to 3 max retries.

Returns:

a new RetryingHttpRequesterFilter.BackOffPolicy that retries failures instantly up-to 3 max retries.

ofImmediateBounded

public static RetryingHttpRequesterFilter.BackOffPolicy ofImmediateBounded()

Creates a new RetryingHttpRequesterFilter.BackOffPolicy that retries failures instantly up-to 3 max retries.

Returns:

a new RetryingHttpRequesterFilter.BackOffPolicy that retries failures instantly up-to 3 max retries.

See Also:

• ofImmediate(int)

ofImmediate

public static RetryingHttpRequesterFilter.BackOffPolicy ofImmediate(int maxRetries)

Creates a new RetryingHttpRequesterFilter.BackOffPolicy that retries failures instantly up-to provided max retries.

Parameters:

maxRetries - the number of retry attempts for this RetryingHttpRequesterFilter.BackOffPolicy.

Returns:

a new RetryingHttpRequesterFilter.BackOffPolicy that retries failures instantly up-to provided max retries.

ofNoRetries

public static RetryingHttpRequesterFilter.BackOffPolicy ofNoRetries()

Special RetryingHttpRequesterFilter.BackOffPolicy that signals that no retries will be attempted.

Returns:

a special RetryingHttpRequesterFilter.BackOffPolicy that signals that no retries will be attempted.

ofConstantBackoffFullJitter

public static RetryingHttpRequesterFilter.BackOffPolicy ofConstantBackoffFullJitter(Duration delay,
 int maxRetries)

Creates a new retrying RetryingHttpRequesterFilter.BackOffPolicy which adds a randomized delay between retries and uses the passed Duration as a maximum delay possible. This additionally adds a "Full Jitter" for the backoff as described here.

Parameters:

delay - Maximum Duration of delay between retries

maxRetries - The maximum retries before it gives up.

Returns:

A new retrying RetryingHttpRequesterFilter.BackOffPolicy which adds a randomized delay between retries

ofConstantBackoffFullJitter

public static RetryingHttpRequesterFilter.BackOffPolicy ofConstantBackoffFullJitter(Duration delay,
 int maxRetries,
 Executor timerExecutor)

Creates a new retrying RetryingHttpRequesterFilter.BackOffPolicy which adds a randomized delay between retries and uses the passed Duration as a maximum delay possible. This additionally adds a "Full Jitter" for the backoff as described here.

Parameters:

delay - Maximum Duration of delay between retries

maxRetries - The maximum retries before it gives up.

timerExecutor - Executor to be used to schedule timers for backoff. It takes precedence over an alternative timer Executor from newStrategy(Executor) argument

Returns:

A new retrying RetryingHttpRequesterFilter.BackOffPolicy which adds a randomized delay between retries

ofConstantBackoffDeltaJitter

public static RetryingHttpRequesterFilter.BackOffPolicy ofConstantBackoffDeltaJitter(Duration delay,
 Duration jitter,
 int maxRetries)

Creates a new retrying RetryingHttpRequesterFilter.BackOffPolicy which adds a randomized delay between retries and uses the passed Duration as a maximum delay possible.

Parameters:

delay - Maximum Duration of delay between retries

jitter - The jitter which is used as and offset to initialDelay on each retry

maxRetries - The maximum retries before it gives up.

Returns:

A new retrying RetryingHttpRequesterFilter.BackOffPolicy which adds a randomized delay between retries

ofConstantBackoffDeltaJitter

public static RetryingHttpRequesterFilter.BackOffPolicy ofConstantBackoffDeltaJitter(Duration delay,
 Duration jitter,
 Executor timerExecutor,
 int maxRetries)

Creates a new retrying RetryingHttpRequesterFilter.BackOffPolicy which adds a randomized delay between retries and uses the passed Duration as a maximum delay possible.

Parameters:

delay - Maximum Duration of delay between retries

jitter - The jitter which is used as and offset to delay on each retry

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

maxRetries - The maximum retries before it gives up. It takes precedence over an alternative timer Executor from newStrategy(Executor) argument

Returns:

A new retrying RetryingHttpRequesterFilter.BackOffPolicy which adds a randomized delay between retries

ofExponentialBackoffFullJitter

public static RetryingHttpRequesterFilter.BackOffPolicy ofExponentialBackoffFullJitter(Duration initialDelay,
 Duration maxDelay,
 int maxRetries)

Creates a new retrying RetryingHttpRequesterFilter.BackOffPolicy which 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.

Parameters:

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

maxDelay - The maximum amount of delay that will be introduced.

maxRetries - The maximum retries before it gives up.

Returns:

A new retrying RetryingHttpRequesterFilter.BackOffPolicy which adds an exponentially increasing delay between retries with jitter

ofExponentialBackoffFullJitter

public static RetryingHttpRequesterFilter.BackOffPolicy ofExponentialBackoffFullJitter(Duration initialDelay,
 Duration maxDelay,
 int maxRetries,
 Executor timerExecutor)

Creates a new retrying RetryingHttpRequesterFilter.BackOffPolicy which 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.

Parameters:

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

maxDelay - The maximum amount of delay that will be introduced.

maxRetries - The maximum retries before it gives up.

timerExecutor - Executor to be used to schedule timers for backoff. It takes precedence over an alternative timer Executor from newStrategy(Executor) argument

Returns:

A new retrying RetryingHttpRequesterFilter.BackOffPolicy which adds an exponentially increasing delay between retries with jitter

ofExponentialBackoffDeltaJitter

public static RetryingHttpRequesterFilter.BackOffPolicy ofExponentialBackoffDeltaJitter(Duration initialDelay,
 Duration jitter,
 Duration maxDelay,
 int maxRetries)

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

Parameters:

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

jitter - The jitter which is used as and offset to initialDelay on each retry

maxDelay - The maximum amount of delay that will be introduced.

maxRetries - The maximum retries before it gives up.

Returns:

A new retrying RetryingHttpRequesterFilter.BackOffPolicy which adds an exponentially increasing delay between retries with jitter

ofExponentialBackoffDeltaJitter

public static RetryingHttpRequesterFilter.BackOffPolicy ofExponentialBackoffDeltaJitter(Duration initialDelay,
 Duration jitter,
 Duration maxDelay,
 int maxRetries,
 Executor timerExecutor)

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

Parameters:

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

jitter - The jitter which is used as and offset to initialDelay on each retry

maxDelay - The maximum amount of delay that will be introduced.

maxRetries - The maximum retries before it gives up.

timerExecutor - Executor to be used to schedule timers for backoff. It takes precedence over an alternative timer Executor from newStrategy(Executor) argument

Returns:

A new retrying RetryingHttpRequesterFilter.BackOffPolicy which adds an exponentially increasing delay between retries with jitter

newStrategy

public BiIntFunction<Throwable,Completable> newStrategy(Executor alternativeTimerExecutor)

Builds a new retry strategy BiIntFunction for retrying with Publisher.retryWhen(BiIntFunction), Single.retryWhen(BiIntFunction), and Completable.retryWhen(BiIntFunction) or in general with an alternative timer Executor.

Parameters:

alternativeTimerExecutor - Executor to be used to schedule timers for backoff if no executor was provided at the build time

Returns:

a new retry strategy BiIntFunction