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) Deprecated. use StreamingRetryAlgorithm(ResultRetryAlgorithmWithContext, TimedRetryAlgorithmWithContext) instead
StreamingRetryAlgorithm(ResultRetryAlgorithmWithContext<ResponseT> resultAlgorithm, TimedRetryAlgorithmWithContext timedAlgorithm) Creates a StreamingRetryAlgorithm that will use the settings (if any) in the RetryingContext that is passed in to the retrying methods.

Method Summary

Modifier and Type	Method and Description
TimedAttemptSettings	createNextAttempt(RetryingContext context, Throwable previousThrowable, ResponseT previousResponse, TimedAttemptSettings previousSettings) Creates a next attempt TimedAttemptSettings.
TimedAttemptSettings	createNextAttempt(Throwable previousThrowable, ResponseT previousResponse, TimedAttemptSettings previousSettings) Creates a next attempt TimedAttemptSettings.
boolean	shouldRetry(RetryingContext context, Throwable previousThrowable, ResponseT previousResponse, TimedAttemptSettings nextAttemptSettings) Returns true if another attempt should be made, or false otherwise.
boolean	shouldRetry(Throwable previousThrowable, ResponseT previousResponse, TimedAttemptSettings nextAttemptSettings) Returns true if another attempt should be made, or false otherwise.

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

createFirstAttempt, createFirstAttempt, getResultAlgorithm, getTimedAlgorithm

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamingRetryAlgorithm

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

Deprecated. use StreamingRetryAlgorithm(ResultRetryAlgorithmWithContext, TimedRetryAlgorithmWithContext) instead

Instances that are created using this constructor will ignore the RetryingContext that is passed in to the retrying methods. Use StreamingRetryAlgorithm(ResultRetryAlgorithmWithContext, TimedRetryAlgorithmWithContext) to create an instance that will respect the RetryingContext.

StreamingRetryAlgorithm

public StreamingRetryAlgorithm(ResultRetryAlgorithmWithContext<ResponseT> resultAlgorithm,
                               TimedRetryAlgorithmWithContext timedAlgorithm)

Creates a StreamingRetryAlgorithm that will use the settings (if any) in the RetryingContext that is passed in to the retrying methods.

Method Detail

createNextAttempt

public TimedAttemptSettings createNextAttempt(Throwable previousThrowable,
                                              ResponseT previousResponse,
                                              TimedAttemptSettings previousSettings)

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:

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

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

previousSettings - previous attempt settings

Returns:

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

createNextAttempt

public TimedAttemptSettings createNextAttempt(RetryingContext context,
                                              Throwable previousThrowable,
                                              ResponseT previousResponse,
                                              TimedAttemptSettings previousSettings)

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:

context - the RetryingContext that can be used to determine the RetrySettings for the next attempt

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

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

previousSettings - previous attempt settings

Returns:

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

shouldRetry

public boolean shouldRetry(Throwable previousThrowable,
                           ResponseT previousResponse,
                           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:

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

previousResponse - 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

shouldRetry

public boolean shouldRetry(RetryingContext context,
                           Throwable previousThrowable,
                           ResponseT previousResponse,
                           TimedAttemptSettings nextAttemptSettings)
                    throws CancellationException

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

Schedules retries only if the StreamResumptionStrategy in the ServerStreamingAttemptCallable supports it.

Overrides:

shouldRetry in class RetryAlgorithm<ResponseT>

Parameters:

context - the RetryingContext that can be used to determine whether another attempt should be made

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

previousResponse - 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 cancelled