com.microsoft.azure.sdk.iot.device.transport

Class ExponentialBackoffWithJitter

java.lang.Object

com.microsoft.azure.sdk.iot.device.transport.ExponentialBackoffWithJitter

All Implemented Interfaces:

RetryPolicy

public class ExponentialBackoffWithJitter
extends Object
implements RetryPolicy

Represents a retry policy that performs exponential backoff with jitter retries.

Constructor Summary

Constructors

Constructor and Description
ExponentialBackoffWithJitter() Constructor with default backoff values and firstFastRetry
ExponentialBackoffWithJitter(int retryCount, long minBackoff, long maxBackoff, long deltaBackoff, boolean firstFastRetry) Constructor.

Method Summary

Modifier and Type	Method and Description
RetryDecision	getRetryDecision(int currentRetryCount, TransportException lastException) Determines whether the operation should be retried and the interval until the next retry.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExponentialBackoffWithJitter

public ExponentialBackoffWithJitter()

Constructor with default backoff values and firstFastRetry

ExponentialBackoffWithJitter

public ExponentialBackoffWithJitter(int retryCount,
                                    long minBackoff,
                                    long maxBackoff,
                                    long deltaBackoff,
                                    boolean firstFastRetry)

Constructor.

Parameters:

retryCount - the max number of retries allowed in the policies.

minBackoff - the min interval between each retry.

maxBackoff - the max interval between each retry.

deltaBackoff - the max delta allowed between retries.

firstFastRetry - indicates whether the first retry should be immediate.

Method Detail

getRetryDecision

public RetryDecision getRetryDecision(int currentRetryCount,
                                      TransportException lastException)

Determines whether the operation should be retried and the interval until the next retry.

Specified by:

getRetryDecision in interface RetryPolicy

Parameters:

currentRetryCount - the number of retries for the given operation

lastException - the latest exception explaining why the retry is happening. This exception is guaranteed to be retryable. In the event of a terminal exception occurring, this API will not be called. Looking at this exception allows you to prevent retry on certain retryable exceptions, but does not allow you to retry exceptions that are terminal.

Returns:

the retry decision.