com.google.api.gax.retrying

Class StreamingRetryAlgorithm<ResponseT>

java.lang.Object

com.google.api.gax.retrying.RetryAlgorithm<ResponseT>

com.google.api.gax.retrying.StreamingRetryAlgorithm<ResponseT>

@InternalApi(value="For internal use only")
public final class StreamingRetryAlgorithm<ResponseT>
extends RetryAlgorithm<ResponseT>

The streaming retry algorithm, which makes decision based either on the thrown exception and the execution time settings of the previous attempt. This extends RetryAlgorithm to take additional information (provided by ServerStreamingAttemptCallable) into account.

This class is thread-safe.

Internal use only - public for technical reasons.

Constructor Summary

Constructors

Constructor and Description
StreamingRetryAlgorithm(ResultRetryAlgorithm<ResponseT> resultAlgorithm, TimedRetryAlgorithm timedAlgorithm)

Method Summary

Modifier and Type	Method and Description
TimedAttemptSettings	createNextAttempt(Throwable prevThrowable, ResponseT prevResponse, TimedAttemptSettings prevSettings) Creates a next attempt TimedAttemptSettings.
boolean	shouldRetry(Throwable prevThrowable, ResponseT prevResponse, TimedAttemptSettings nextAttemptSettings) Returns true if another attempt should be made, or false otherwise.

Methods inherited from class com.google.api.gax.retrying.RetryAlgorithm

createFirstAttempt

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamingRetryAlgorithm

public StreamingRetryAlgorithm(ResultRetryAlgorithm<ResponseT> resultAlgorithm,
                               TimedRetryAlgorithm timedAlgorithm)

Method Detail

createNextAttempt

public TimedAttemptSettings createNextAttempt(Throwable prevThrowable,
                                              ResponseT prevResponse,
                                              TimedAttemptSettings prevSettings)

Creates a next attempt TimedAttemptSettings. This method will return first non-null value, returned by either result or timed retry algorithms in that particular order.

The attempt settings will be reset if the stream attempt produced any messages.

Overrides:

createNextAttempt in class RetryAlgorithm<ResponseT>

Parameters:

prevThrowable - exception thrown by the previous attempt or null if a result was returned instead

prevResponse - response returned by the previous attempt or null if an exception was thrown instead

prevSettings - previous attempt settings

Returns:

next attempt settings, can be null, if no there should be no new attempt

shouldRetry

public boolean shouldRetry(Throwable prevThrowable,
                           ResponseT prevResponse,
                           TimedAttemptSettings nextAttemptSettings)
                    throws CancellationException

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

Ensures retries are only scheduled if the StreamResumptionStrategy in the ServerStreamingAttemptCallable supports it.

Overrides:

shouldRetry in class RetryAlgorithm<ResponseT>

Parameters:

prevThrowable - exception thrown by the previous attempt or null if a result was returned instead

prevResponse - response returned by the previous attempt or null if an exception was thrown instead

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

Returns:

true if another attempt should be made, or false otherwise

Throws:

CancellationException - if the retrying process should be canceled