Package com.google.api.gax.retrying

Class ExponentialRetryAlgorithm

java.lang.Object

com.google.api.gax.retrying.ExponentialRetryAlgorithm

All Implemented Interfaces:

TimedRetryAlgorithm, TimedRetryAlgorithmWithContext

Direct Known Subclasses:

ExponentialPollAlgorithm, OperationTimedPollAlgorithm

public class ExponentialRetryAlgorithm
extends Object
implements TimedRetryAlgorithmWithContext

The timed retry algorithm which uses jittered exponential backoff factor for calculating the next attempt execution time.

This class is thread-safe.

Constructor Summary

Constructors

Constructor	Description
ExponentialRetryAlgorithm(RetrySettings globalSettings, ApiClock clock)	Creates a new exponential retry algorithm instance.

Method Summary

Modifier and Type	Method	Description
TimedAttemptSettings	createFirstAttempt()	Creates a first attempt TimedAttemptSettings.
TimedAttemptSettings	createFirstAttempt(RetryingContext context)	Creates a first attempt TimedAttemptSettings.
TimedAttemptSettings	createNextAttempt(RetryingContext context, TimedAttemptSettings previousSettings)	Creates a next attempt TimedAttemptSettings.
TimedAttemptSettings	createNextAttempt(TimedAttemptSettings previousSettings)	Creates a next attempt TimedAttemptSettings.
protected long	nextRandomLong(long bound)
boolean	shouldRetry(RetryingContext context, TimedAttemptSettings nextAttemptSettings)	Returns true if another attempt should be made, or false otherwise.
boolean	shouldRetry(TimedAttemptSettings nextAttemptSettings)	Returns true if another attempt should be made, or false otherwise.
protected boolean	shouldRPCTerminate(long timeLeftMs)

Methods inherited from class java.lang.Object

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

Constructor Details

ExponentialRetryAlgorithm

public ExponentialRetryAlgorithm(RetrySettings globalSettings,
 ApiClock clock)

Creates a new exponential retry algorithm instance.

Parameters:

globalSettings - global retry settings (attempt independent)

clock - clock to use for time-specific calculations

Throws:

NullPointerException - if either globalSettings or clock is null

Method Details

createFirstAttempt

public TimedAttemptSettings createFirstAttempt()

Creates a first attempt TimedAttemptSettings. The first attempt is configured to be executed immediately.

Specified by:

createFirstAttempt in interface TimedRetryAlgorithm

Returns:

first attempt settings

createFirstAttempt

public TimedAttemptSettings createFirstAttempt(RetryingContext context)

Creates a first attempt TimedAttemptSettings. The first attempt is configured to be executed immediately.

Specified by:

createFirstAttempt in interface TimedRetryAlgorithmWithContext

Parameters:

context - a RetryingContext that can contain custom RetrySettings and retryable codes

Returns:

first attempt settings

createNextAttempt

public TimedAttemptSettings createNextAttempt(TimedAttemptSettings previousSettings)

Creates a next attempt TimedAttemptSettings. The implementation increments the current attempt count and uses randomized exponential backoff factor for calculating next attempt execution time.

Specified by:

createNextAttempt in interface TimedRetryAlgorithm

Parameters:

previousSettings - previous attempt settings

Returns:

next attempt settings

createNextAttempt

public TimedAttemptSettings createNextAttempt(RetryingContext context,
 TimedAttemptSettings previousSettings)

Creates a next attempt TimedAttemptSettings. The implementation increments the current attempt count and uses randomized exponential backoff factor for calculating next attempt execution time.

Specified by:

createNextAttempt in interface TimedRetryAlgorithmWithContext

Parameters:

context - a RetryingContext that can contain custom RetrySettings and retryable codes

previousSettings - previous attempt settings

Returns:

next attempt settings

shouldRetry

public boolean shouldRetry(TimedAttemptSettings nextAttemptSettings)

Returns true if another attempt should be made, or false otherwise.

Specified by:

shouldRetry in interface TimedRetryAlgorithm

Parameters:

nextAttemptSettings - attempt settings, which will be used for the next attempt, if accepted

Returns:

true if nextAttemptSettings does not exceed either maxAttempts limit or totalTimeout limit, or false otherwise

shouldRPCTerminate

@InternalApi
protected boolean shouldRPCTerminate(long timeLeftMs)

shouldRetry

public boolean shouldRetry(RetryingContext context,
 TimedAttemptSettings nextAttemptSettings)

Returns true if another attempt should be made, or false otherwise.

Specified by:

shouldRetry in interface TimedRetryAlgorithmWithContext

Parameters:

context - a RetryingContext that can contain custom RetrySettings and retryable codes. Ignored by this implementation.

nextAttemptSettings - attempt settings, which will be used for the next attempt, if accepted

Returns:

true if nextAttemptSettings does not exceed either maxAttempts limit or totalTimeout limit, or false otherwise

nextRandomLong

protected long nextRandomLong(long bound)