reactor.util.retry

Interface Retry.RetrySignal

Enclosing class:

Retry

public static interface Retry.RetrySignal

State for a Flux.retryWhen(Retry) Flux retry} or Mono retry. A flux of states is passed to the user, which gives information about the failure() that potentially triggers a retry as well as two indexes: the number of errors that happened so far (and were retried) and the same number, but only taking into account subsequent errors (see totalRetriesInARow()).

Method Summary

Modifier and Type	Method and Description
default Retry.RetrySignal	copy() Return an immutable copy of this Retry.RetrySignal which is guaranteed to give a consistent view of the state at the time at which this method is invoked.
Throwable	failure() The current Throwable that needs to be evaluated for retry.
default ContextView	retryContextView() Return a read-only view of the user provided context, which may be used to store objects to be reset/rollbacked or otherwise mutated before or after a retry.
long	totalRetries() The ZERO BASED index number of this error (can also be read as how many retries have occurred so far), since the source was first subscribed to.
long	totalRetriesInARow() The ZERO BASED index number of this error since the beginning of the current burst of errors.

Method Detail

totalRetries

long totalRetries()

The ZERO BASED index number of this error (can also be read as how many retries have occurred so far), since the source was first subscribed to.

Returns:

a 0-index for the error, since original subscription

totalRetriesInARow

long totalRetriesInARow()

The ZERO BASED index number of this error since the beginning of the current burst of errors. This is reset to zero whenever a retry is made that is followed by at least one onNext.

Returns:

a 0-index for the error in the current burst of subsequent errors

failure

Throwable failure()

The current Throwable that needs to be evaluated for retry.

Returns:

the current failure Throwable

retryContextView

default ContextView retryContextView()

Return a read-only view of the user provided context, which may be used to store objects to be reset/rollbacked or otherwise mutated before or after a retry.

Returns:

a read-only view of a user provided context.

copy

default Retry.RetrySignal copy()

Return an immutable copy of this Retry.RetrySignal which is guaranteed to give a consistent view of the state at the time at which this method is invoked. This is especially useful if this Retry.RetrySignal is a transient view of the state of the underlying retry subscriber,

Returns:

an immutable copy of the current Retry.RetrySignal, always safe to use