Share via

RetryPolicy Interface

  • Reference
Package:
com.microsoft.azure.sdk.iot.device.transport
Maven Artifact:
com.microsoft.azure.sdk.iot:iot-device-client:1.30.1

public interface RetryPolicy

An interface for the retry policy.

Method Summary

Modifier and Type Method and Description
abstract RetryDecision getRetryDecision(int currentRetryCount, TransportException lastException)

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

Method Details

getRetryDecision

public abstract RetryDecision getRetryDecision(int currentRetryCount, TransportException lastException)

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

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.

Applies to