RetryBackoffSpec (reactor-3)

java.lang.Object
- reactor.util.retry.Retry
- - reactor.util.retry.RetryBackoffSpec

```
public final class RetryBackoffSpec
extends Retry
```
A Retry strategy based on exponential backoffs, with configurable features. Use Retry.backoff(long, Duration) to obtain a preconfigured instance to start with.
Retry delays are randomized with a user-provided jitter(double) factor between 0.d (no jitter) and 1.0 (default is 0.5). Even with the jitter, the effective backoff delay cannot be less than minBackoff(Duration) nor more than maxBackoff(Duration). The delays and subsequent attempts are executed on the provided backoff scheduler(Scheduler). Alternatively, Retry.fixedDelay(long, Duration) provides a strategy where the min and max backoffs are the same and jitters are deactivated.
Only errors that match the filter(Predicate) are retried (by default all), and the number of attempts can also limited with maxAttempts(long). When the maximum attempt of retries is reached, a runtime exception is propagated downstream which can be pinpointed with Exceptions.isRetryExhausted(Throwable). The cause of the last attempt's failure is attached as said retryExhausted exception's cause. This can be customized with onRetryExhaustedThrow(BiFunction).
Additionally, to help dealing with bursts of transient errors in a long-lived Flux as if each burst had its own backoff, one can choose to set transientErrors(boolean) to true. The comparison to maxAttempts(long) will then be done with the number of subsequent attempts that failed without an onNext in between.
The RetryBackoffSpec is copy-on-write and as such can be stored as a "template" and further configured by different components without a risk of modifying the original configuration.

作者:

Simon Baslé

嵌套类概要
- 从类继承的嵌套类/接口 reactor.util.retry.Retry
  Retry.RetrySignal

字段概要

字段
限定符和类型	字段和说明
`java.util.function.Supplier<Scheduler>`	`backoffSchedulerSupplier` The configured `Supplier` of `Scheduler` on which to execute backoffs.
`java.util.function.Predicate<java.lang.Throwable>`	`errorFilter` The configured `Predicate` to filter which exceptions to retry.
`boolean`	`isTransientErrors` The configured transient error handling flag.
`double`	`jitterFactor` The configured jitter factor, as a `double`.
`long`	`maxAttempts` The configured maximum for retry attempts.
`java.time.Duration`	`maxBackoff` The configured maximum backoff `Duration`.
`java.time.Duration`	`minBackoff` The configured minimum backoff `Duration`.

从类继承的字段 reactor.util.retry.Retry
retryContext

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`RetryBackoffSpec`	`doAfterRetry(java.util.function.Consumer<Retry.RetrySignal> doAfterRetry)` Add synchronous behavior to be executed after the retry trigger is emitted in the companion publisher.
`RetryBackoffSpec`	`doAfterRetryAsync(java.util.function.Function<Retry.RetrySignal,Mono<java.lang.Void>> doAsyncAfterRetry)` Add asynchronous behavior to be executed after the current retry trigger in the companion publisher, thus delaying the resulting retry trigger with the additional `Mono`.
`RetryBackoffSpec`	`doBeforeRetry(java.util.function.Consumer<Retry.RetrySignal> doBeforeRetry)` Add synchronous behavior to be executed before the retry trigger is emitted in the companion publisher.
`RetryBackoffSpec`	`doBeforeRetryAsync(java.util.function.Function<Retry.RetrySignal,Mono<java.lang.Void>> doAsyncBeforeRetry)` Add asynchronous behavior to be executed before the current retry trigger in the companion publisher, thus delaying the resulting retry trigger with the additional `Mono`.
`RetryBackoffSpec`	`filter(java.util.function.Predicate<? super java.lang.Throwable> errorFilter)` Set the `Predicate` that will filter which errors can be retried.
`Flux<java.lang.Long>`	`generateCompanion(Flux<Retry.RetrySignal> t)` Generates the companion publisher responsible for reacting to incoming `Retry.RetrySignal` emissions, effectively deciding when to retry.
`RetryBackoffSpec`	`jitter(double jitterFactor)` Set a jitter factor for exponential backoffs that adds randomness to each backoff.
`RetryBackoffSpec`	`maxAttempts(long maxAttempts)` Set the maximum number of retry attempts allowed. 1 meaning "1 retry attempt": the original subscription plus an extra re-subscription in case of an error, but no more.
`RetryBackoffSpec`	`maxBackoff(java.time.Duration maxBackoff)` Set a hard maximum `Duration` for exponential backoffs.
`RetryBackoffSpec`	`minBackoff(java.time.Duration minBackoff)` Set the minimum `Duration` for the first backoff.
`RetryBackoffSpec`	`modifyErrorFilter(java.util.function.Function<java.util.function.Predicate<java.lang.Throwable>,java.util.function.Predicate<? super java.lang.Throwable>> predicateAdjuster)` Allows to augment a previously `set` `Predicate` with a new condition to allow retries of some exception or not.
`RetryBackoffSpec`	`onRetryExhaustedThrow(java.util.function.BiFunction<RetryBackoffSpec,Retry.RetrySignal,java.lang.Throwable> retryExhaustedGenerator)` Set the generator for the `Exception` to be propagated when the maximum amount of retries is exhausted.
`RetryBackoffSpec`	`scheduler(Scheduler backoffScheduler)` Set a `Scheduler` on which to execute the delays computed by the exponential backoff strategy.
`RetryBackoffSpec`	`transientErrors(boolean isTransientErrors)` Set the transient error mode, indicating that the strategy being built should use `Retry.RetrySignal.totalRetriesInARow()` rather than `Retry.RetrySignal.totalRetries()`.
`RetryBackoffSpec`	`withRetryContext(ContextView retryContext)` Set the user provided `context` that can be used to manipulate state on retries.

从类继承的方法 reactor.util.retry.Retry
backoff, fixedDelay, from, indefinitely, max, maxInARow, retryContext, withThrowable

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - minBackoff
```
public final java.time.Duration minBackoff
```
    The configured minimum backoff Duration.
    
    另请参阅:
    
    minBackoff(Duration)
  - maxBackoff
```
public final java.time.Duration maxBackoff
```
    The configured maximum backoff Duration.
    
    另请参阅:
    
    maxBackoff(Duration)
  - jitterFactor
```
public final double jitterFactor
```
    The configured jitter factor, as a double.
    
    另请参阅:
    
    jitter(double)
  - backoffSchedulerSupplier
```
public final java.util.function.Supplier<Scheduler> backoffSchedulerSupplier
```
    The configured Supplier of Scheduler on which to execute backoffs.
    
    另请参阅:
    
    scheduler(Scheduler)
  - maxAttempts
```
public final long maxAttempts
```
    The configured maximum for retry attempts.
    
    另请参阅:
    
    maxAttempts(long)
  - errorFilter
```
public final java.util.function.Predicate<java.lang.Throwable> errorFilter
```
    The configured Predicate to filter which exceptions to retry.
    
    另请参阅:
    
    filter(Predicate), modifyErrorFilter(Function)
  - isTransientErrors
```
public final boolean isTransientErrors
```
    The configured transient error handling flag.
    
    另请参阅:
    
    transientErrors(boolean)
- 方法详细资料
  - withRetryContext
```
public RetryBackoffSpec withRetryContext(ContextView retryContext)
```
    Set the user provided context that can be used to manipulate state on retries.
    
    参数:
    
    retryContext - a new snapshot of user provided data
    
    返回:
    
    a new copy of the RetryBackoffSpec which can either be further configured or used as Retry
  - maxAttempts
```
public RetryBackoffSpec maxAttempts(long maxAttempts)
```
    Set the maximum number of retry attempts allowed. 1 meaning "1 retry attempt": the original subscription plus an extra re-subscription in case of an error, but no more.
    
    参数:
    
    maxAttempts - the new retry attempt limit
    
    返回:
    
    a new copy of the RetryBackoffSpec which can either be further configured or used as Retry
  - filter
```
public RetryBackoffSpec filter(java.util.function.Predicate<? super java.lang.Throwable> errorFilter)
```
    Set the Predicate that will filter which errors can be retried. Exceptions that don't pass the predicate will be propagated downstream and terminate the retry sequence. Defaults to allowing retries for all exceptions.
    
    参数:
    
    errorFilter - the predicate to filter which exceptions can be retried
    
    返回:
    
    a new copy of the RetryBackoffSpec which can either be further configured or used as Retry
  - modifyErrorFilter
```
public RetryBackoffSpec modifyErrorFilter(java.util.function.Function<java.util.function.Predicate<java.lang.Throwable>,java.util.function.Predicate<? super java.lang.Throwable>> predicateAdjuster)
```
    Allows to augment a previously set Predicate with a new condition to allow retries of some exception or not. This can typically be used with Predicate.and(Predicate) to combine existing predicate(s) with a new one.
    For example:
```
 //given
 RetrySpec retryTwiceIllegalArgument = Retry.max(2)
     .filter(e -> e instanceof IllegalArgumentException);

 RetrySpec retryTwiceIllegalArgWithCause = retryTwiceIllegalArgument.modifyErrorFilter(old ->
     old.and(e -> e.getCause() != null));
 
```
    参数:
    
    predicateAdjuster - a Function that returns a new Predicate given the currently in place Predicate (usually deriving from the old predicate).
    
    返回:
    
    a new copy of the RetryBackoffSpec which can either be further configured or used as Retry
  - doBeforeRetry
```
public RetryBackoffSpec doBeforeRetry(java.util.function.Consumer<Retry.RetrySignal> doBeforeRetry)
```
    Add synchronous behavior to be executed before the retry trigger is emitted in the companion publisher. This should not be blocking, as the companion publisher might be executing in a shared thread.
    
    参数:
    
    doBeforeRetry - the synchronous hook to execute before retry trigger is emitted
    
    返回:
    
    a new copy of the RetryBackoffSpec which can either be further configured or used as Retry
    
    另请参阅:
    
    andDelayRetryWith for an asynchronous version
  - doAfterRetry
```
public RetryBackoffSpec doAfterRetry(java.util.function.Consumer<Retry.RetrySignal> doAfterRetry)
```
    Add synchronous behavior to be executed after the retry trigger is emitted in the companion publisher. This should not be blocking, as the companion publisher might be publishing events in a shared thread.
    
    参数:
    
    doAfterRetry - the synchronous hook to execute after retry trigger is started
    
    返回:
    
    a new copy of the RetryBackoffSpec which can either be further configured or used as Retry
    
    另请参阅:
    
    andRetryThen for an asynchronous version
  - doBeforeRetryAsync
```
public RetryBackoffSpec doBeforeRetryAsync(java.util.function.Function<Retry.RetrySignal,Mono<java.lang.Void>> doAsyncBeforeRetry)
```
    Add asynchronous behavior to be executed before the current retry trigger in the companion publisher, thus delaying the resulting retry trigger with the additional Mono.
    
    参数:
    
    doAsyncBeforeRetry - the asynchronous hook to execute before original retry trigger is emitted
    
    返回:
    
    a new copy of the RetryBackoffSpec which can either be further configured or used as Retry
  - doAfterRetryAsync
```
public RetryBackoffSpec doAfterRetryAsync(java.util.function.Function<Retry.RetrySignal,Mono<java.lang.Void>> doAsyncAfterRetry)
```
    Add asynchronous behavior to be executed after the current retry trigger in the companion publisher, thus delaying the resulting retry trigger with the additional Mono.
    
    参数:
    
    doAsyncAfterRetry - the asynchronous hook to execute after original retry trigger is emitted
    
    返回:
    
    a new copy of the RetryBackoffSpec which can either be further configured or used as Retry
  - onRetryExhaustedThrow
```
public RetryBackoffSpec onRetryExhaustedThrow(java.util.function.BiFunction<RetryBackoffSpec,Retry.RetrySignal,java.lang.Throwable> retryExhaustedGenerator)
```
    Set the generator for the Exception to be propagated when the maximum amount of retries is exhausted. By default, throws an Exceptions.retryExhausted(String, Throwable) with the message reflecting the total attempt index, transient attempt index and maximum retry count. The cause of the last Retry.RetrySignal is also added as the exception's cause.
    
    参数:
    
    retryExhaustedGenerator - the Function that generates the Throwable for the last Retry.RetrySignal
    
    返回:
    
    a new copy of the RetryBackoffSpec which can either be further configured or used as Retry
  - transientErrors
```
public RetryBackoffSpec transientErrors(boolean isTransientErrors)
```
    Set the transient error mode, indicating that the strategy being built should use Retry.RetrySignal.totalRetriesInARow() rather than Retry.RetrySignal.totalRetries(). Transient errors are errors that could occur in bursts but are then recovered from by a retry (with one or more onNext signals) before another error occurs.
    For a backoff based retry, the backoff is also computed based on the index within the burst, meaning the next error after a recovery will be retried with a minBackoff(Duration) delay.
    
    参数:
    
    isTransientErrors - true to activate transient mode
    
    返回:
    
    a new copy of the RetryBackoffSpec which can either be further configured or used as Retry
  - minBackoff
```
public RetryBackoffSpec minBackoff(java.time.Duration minBackoff)
```
    Set the minimum Duration for the first backoff. This method switches to an exponential backoff strategy if not already done so. Defaults to Duration.ZERO when the strategy was initially not a backoff one.
    
    参数:
    
    minBackoff - the minimum backoff Duration
    
    返回:
    
    a new copy of the RetryBackoffSpec which can either be further configured or used as Retry
  - maxBackoff
```
public RetryBackoffSpec maxBackoff(java.time.Duration maxBackoff)
```
    Set a hard maximum Duration for exponential backoffs. This method switches to an exponential backoff strategy with a zero minimum backoff if not already a backoff strategy. Defaults to Duration.ofMillis(Long.MAX_VALUE).
    
    参数:
    
    maxBackoff - the maximum backoff Duration
    
    返回:
    
    a new copy of the RetryBackoffSpec which can either be further configured or used as Retry
  - jitter
```
public RetryBackoffSpec jitter(double jitterFactor)
```
    Set a jitter factor for exponential backoffs that adds randomness to each backoff. This can be helpful in reducing cascading failure due to retry-storms. This method switches to an exponential backoff strategy with a zero minimum backoff if not already a backoff strategy. Defaults to 0.5 (a jitter of at most 50% of the computed delay).
    
    参数:
    
    jitterFactor - the new jitter factor as a double between 0d and 1d
    
    返回:
    
    a new copy of the RetryBackoffSpec which can either be further configured or used as Retry
  - scheduler
```
public RetryBackoffSpec scheduler(@Nullable
                                  Scheduler backoffScheduler)
```
    Set a Scheduler on which to execute the delays computed by the exponential backoff strategy. Defaults to a deferred resolution of the current Schedulers.parallel() (use null to reset to this default).
    
    参数:
    
    backoffScheduler - the Scheduler to use, or null to revert to the default
    
    返回:
    
    a new copy of the RetryBackoffSpec which can either be further configured or used as Retry
  - generateCompanion
```
public Flux<java.lang.Long> generateCompanion(Flux<Retry.RetrySignal> t)
```
    从类复制的说明: Retry
    
    Generates the companion publisher responsible for reacting to incoming Retry.RetrySignal emissions, effectively deciding when to retry.
    When the source signals an error, that onError signal will be suppressed. Its Throwable will instead be attached to a Retry.RetrySignal, immediately emitted on the retrySignals publisher. Right after that emission, request(1) is called on the companion publisher.
    The response to that request decides if a retry should be made. Thus, the outer publisher will wait until a signal is emitted by the companion publisher, making it possible to delay retry attempts.
    Any onNext emitted by the companion publisher triggers a retry, onError will fail the outer publisher and onComplete will complete the outer publisher (effectively suppressing the original error/Throwable).
    As an example, the simplest form of retry companion would be to return the incoming Flux of Retry.RetrySignal without modification. This would render a retry strategy that immediately retries, forever.
    
    指定者:
    
    generateCompanion 在类中 Retry
    
    参数:
    
    t - the errors from the outer publisher as Retry.RetrySignal objects, containing the Throwable causing the error as well as retry counter metadata.
    
    返回:
    
    the companion publisher responsible for reacting to incoming Retry.RetrySignal emissions, effectively deciding when to retry.

类 RetryBackoffSpec

嵌套类概要

从类继承的嵌套类/接口 reactor.util.retry.Retry

字段概要

从类继承的字段 reactor.util.retry.Retry

方法概要

从类继承的方法 reactor.util.retry.Retry

从类继承的方法 java.lang.Object

字段详细资料

minBackoff

maxBackoff

jitterFactor

backoffSchedulerSupplier

maxAttempts

errorFilter

isTransientErrors

方法详细资料

withRetryContext

maxAttempts

filter

modifyErrorFilter

doBeforeRetry

doAfterRetry

doBeforeRetryAsync

doAfterRetryAsync

onRetryExhaustedThrow

transientErrors

minBackoff

maxBackoff

jitter

scheduler

generateCompanion