io.servicetalk.client.api

Class AbstractRetryingFilterBuilder<Builder extends AbstractRetryingFilterBuilder<Builder,Filter,Meta>,Filter,Meta>

java.lang.Object

io.servicetalk.client.api.AbstractRetryingFilterBuilder<Builder,Filter,Meta>

Type Parameters:

Builder - the type of builder for retrying filter

Filter - the type of retrying filter to build

Meta - the type of meta-data for retryFor(BiPredicate)

Direct Known Subclasses:

RetryingHttpRequesterFilter.Builder

public abstract class AbstractRetryingFilterBuilder<Builder extends AbstractRetryingFilterBuilder<Builder,Filter,Meta>,Filter,Meta>
extends java.lang.Object

An abstract builder for retrying filters.

See Also:

RetryStrategies

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractRetryingFilterBuilder.ReadOnlyRetryableSettings<Meta> A read-only settings for retryable filters.

Constructor Summary

Constructors

Constructor and Description
AbstractRetryingFilterBuilder()

Method Summary

Modifier and Type	Method and Description
protected abstract Filter	build(AbstractRetryingFilterBuilder.ReadOnlyRetryableSettings<Meta> readOnlySettings) Builds a retrying Filter for provided ReadOnlyRetryableSettings<Meta>.
Filter	buildWithConstantBackoff(java.time.Duration delay) Creates a new retrying Filter which adds the passed constant Duration as a delay between retries.
Filter	buildWithConstantBackoff(java.time.Duration delay, Executor timerExecutor) Creates a new retrying Filter which adds the passed constant Duration as a delay between retries.
Filter	buildWithConstantBackoffAndJitter(java.time.Duration delay) Creates a new retrying Filter which adds a randomized delay between retries and uses the passed Duration as a maximum delay possible.
Filter	buildWithConstantBackoffAndJitter(java.time.Duration delay, Executor timerExecutor) Creates a new retrying Filter which adds a randomized delay between retries and uses the passed Duration as a maximum delay possible.
Filter	buildWithExponentialBackoff(java.time.Duration initialDelay) Creates a new retrying Filter which adds a delay between retries.
Filter	buildWithExponentialBackoff(java.time.Duration initialDelay, Executor timerExecutor) Creates a new retrying Filter which adds a delay between retries.
Filter	buildWithExponentialBackoffAndJitter(java.time.Duration initialDelay) Creates a new retrying Filter which adds a delay between retries.
Filter	buildWithExponentialBackoffAndJitter(java.time.Duration initialDelay, Executor timerExecutor) Creates a new retrying Filter which adds a delay between retries.
Filter	buildWithImmediateRetries() Creates a new retrying Filter which retries without delay.
java.util.function.BiPredicate<Meta,java.lang.Throwable>	defaultRetryForPredicate() Returns a default value for retryFor(BiPredicate).
Builder	maxRetries(int maxRetries) Set the maximum number of allowed retry operations before giving up.
Builder	retryFor(java.util.function.BiPredicate<Meta,java.lang.Throwable> retryForPredicate) Overrides the default criterion for determining which requests or errors should be retried.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRetryingFilterBuilder

public AbstractRetryingFilterBuilder()

Method Detail

maxRetries

public final Builder maxRetries(int maxRetries)

Set the maximum number of allowed retry operations before giving up.

Parameters:

maxRetries - Maximum number of allowed retries before giving up

Returns:

this

retryFor

public final Builder retryFor(java.util.function.BiPredicate<Meta,java.lang.Throwable> retryForPredicate)

Overrides the default criterion for determining which requests or errors should be retried.

Parameters:

retryForPredicate - BiPredicate that checks whether a given combination of meta-data and cause should be retried

Returns:

this

buildWithImmediateRetries

public final Filter buildWithImmediateRetries()

Creates a new retrying Filter which retries without delay.

Returns:

a new retrying Filter which retries without delay

buildWithConstantBackoff

public final Filter buildWithConstantBackoff(java.time.Duration delay)

Creates a new retrying Filter which adds the passed constant Duration as a delay between retries.

Parameters:

delay - Constant Duration of delay between retries

Returns:

A new retrying Filter which adds a constant delay between retries

buildWithConstantBackoff

public final Filter buildWithConstantBackoff(java.time.Duration delay,
                                             Executor timerExecutor)

Creates a new retrying Filter which adds the passed constant Duration as a delay between retries.

Parameters:

delay - Constant Duration of delay between retries

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

Returns:

A new retrying Filter which adds a constant delay between retries

buildWithConstantBackoffAndJitter

public final Filter buildWithConstantBackoffAndJitter(java.time.Duration delay)

Creates a new retrying Filter 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

Returns:

A new retrying Filter which adds a randomized delay between retries

buildWithConstantBackoffAndJitter

public final Filter buildWithConstantBackoffAndJitter(java.time.Duration delay,
                                                      Executor timerExecutor)

Creates a new retrying Filter 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

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

Returns:

A new retrying Filter which adds a randomized delay between retries

buildWithExponentialBackoff

public final Filter buildWithExponentialBackoff(java.time.Duration initialDelay)

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

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

Parameters:

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

Returns:

A new retrying Filter which adds an exponentially increasing delay between retries

buildWithExponentialBackoff

public final Filter buildWithExponentialBackoff(java.time.Duration initialDelay,
                                                Executor timerExecutor)

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

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

Parameters:

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

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

Returns:

A new retrying Filter which adds an exponentially increasing delay between retries

buildWithExponentialBackoffAndJitter

public final Filter buildWithExponentialBackoffAndJitter(java.time.Duration initialDelay)

Creates a new retrying Filter 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.

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

Parameters:

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

Returns:

A new retrying Filter which adds an exponentially increasing delay between retries with jitter

buildWithExponentialBackoffAndJitter

public final Filter buildWithExponentialBackoffAndJitter(java.time.Duration initialDelay,
                                                         Executor timerExecutor)

Creates a new retrying Filter 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.

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

Parameters:

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

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

Returns:

A new retrying Filter which adds an exponentially increasing delay between retries with jitter

build

protected abstract Filter build(AbstractRetryingFilterBuilder.ReadOnlyRetryableSettings<Meta> readOnlySettings)

Builds a retrying Filter for provided ReadOnlyRetryableSettings<Meta>.

Parameters:

readOnlySettings - a read-only settings for retryable filters

Returns:

A new retrying Filter

defaultRetryForPredicate

public java.util.function.BiPredicate<Meta,java.lang.Throwable> defaultRetryForPredicate()

Returns a default value for retryFor(BiPredicate).

Returns:

a default value for retryFor(BiPredicate)