com.google.api.gax.retrying

Interface TimedRetryAlgorithm

All Known Implementing Classes:

ExponentialPollAlgorithm, ExponentialRetryAlgorithm, OperationTimedPollAlgorithm

public interface TimedRetryAlgorithm

A timed retry algorithm is responsible for the following operations, based on the previous attempt settings and current time:

1. Creating first attempt TimedAttemptSettings.
2. Accepting a task for retry so another attempt will be made.
3. Canceling retrying process so the related Future will be canceled.
4. Creating TimedAttemptSettings for each subsequent retry attempt.

Implementations of this interface must be be thread-save.

Method Summary

Modifier and Type	Method and Description
TimedAttemptSettings	createFirstAttempt() Creates a first attempt TimedAttemptSettings.
TimedAttemptSettings	createNextAttempt(TimedAttemptSettings prevSettings) Creates a next attempt TimedAttemptSettings, which defines properties of the next attempt.
boolean	shouldRetry(TimedAttemptSettings nextAttemptSettings) Returns true if another attempt should be made, or false otherwise.

Method Detail

createFirstAttempt

TimedAttemptSettings createFirstAttempt()

Creates a first attempt TimedAttemptSettings.

Returns:

first attempt settings

createNextAttempt

TimedAttemptSettings createNextAttempt(TimedAttemptSettings prevSettings)

Creates a next attempt TimedAttemptSettings, which defines properties of the next attempt.

Parameters:

prevSettings - previous attempt settings

Returns:

next attempt settings or null if the implementing algorithm does not provide specific settings for the next attempt

shouldRetry

boolean shouldRetry(TimedAttemptSettings nextAttemptSettings)
             throws CancellationException

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

Parameters:

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

Throws:

CancellationException - if the retrying process should be canceled