com.smartsheet.api.retry

Interface CalcBackoff

public interface CalcBackoff

Interface for user provided backoff calculation callbacks

Method Summary

Modifier and Type	Method and Description
long	calcBackoff(int previousAttempts, long totalElapsedTimeMillis, Error error) Determines the backoff time after a failed API call.

Method Detail

calcBackoff

long calcBackoff(int previousAttempts,
                 long totalElapsedTimeMillis,
                 Error error)

Determines the backoff time after a failed API call. The default implementation uses an exponential backoff calculation.

Parameters:

previousAttempts -

totalElapsedTimeMillis -

error -

Returns:

a positive value indicates that API requests should continue to be made, a return value of -1 will cause the caller to drop out of the retry loop.