-
Notifications
You must be signed in to change notification settings - Fork 224
/
com.microsoft.azure.sdk.iot.device.transport.ExponentialBackoffWithJitter.yml
78 lines (78 loc) · 6.5 KB
/
com.microsoft.azure.sdk.iot.device.transport.ExponentialBackoffWithJitter.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
### YamlMime:JavaType
uid: "com.microsoft.azure.sdk.iot.device.transport.ExponentialBackoffWithJitter"
fullName: "com.microsoft.azure.sdk.iot.device.transport.ExponentialBackoffWithJitter"
name: "ExponentialBackoffWithJitter"
nameWithType: "ExponentialBackoffWithJitter"
summary: "Represents a retry policy that performs exponential backoff with jitter retries."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
syntax: "public class **ExponentialBackoffWithJitter**</br> implements <xref href=\"com.microsoft.azure.sdk.iot.device.transport.RetryPolicy?alt=com.microsoft.azure.sdk.iot.device.transport.RetryPolicy&text=RetryPolicy\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.microsoft.azure.sdk.iot.device.transport.ExponentialBackoffWithJitter.ExponentialBackoffWithJitter()"
fullName: "com.microsoft.azure.sdk.iot.device.transport.ExponentialBackoffWithJitter.ExponentialBackoffWithJitter()"
name: "ExponentialBackoffWithJitter()"
nameWithType: "ExponentialBackoffWithJitter.ExponentialBackoffWithJitter()"
summary: "Constructor with default backoff values and first<wbr>Fast<wbr>Retry"
syntax: "public ExponentialBackoffWithJitter()"
desc: "Constructor with default backoff values and firstFastRetry"
- uid: "com.microsoft.azure.sdk.iot.device.transport.ExponentialBackoffWithJitter.ExponentialBackoffWithJitter(int,long,long,long,boolean)"
fullName: "com.microsoft.azure.sdk.iot.device.transport.ExponentialBackoffWithJitter.ExponentialBackoffWithJitter(int retryCount, long minBackoff, long maxBackoff, long deltaBackoff, boolean firstFastRetry)"
name: "ExponentialBackoffWithJitter(int retryCount, long minBackoff, long maxBackoff, long deltaBackoff, boolean firstFastRetry)"
nameWithType: "ExponentialBackoffWithJitter.ExponentialBackoffWithJitter(int retryCount, long minBackoff, long maxBackoff, long deltaBackoff, boolean firstFastRetry)"
summary: "Constructor."
parameters:
- description: "the max number of retries allowed in the policies."
name: "retryCount"
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- description: "the min interval between each retry."
name: "minBackoff"
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
- description: "the max interval between each retry."
name: "maxBackoff"
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
- description: "the max delta allowed between retries."
name: "deltaBackoff"
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
- description: "indicates whether the first retry should be immediate."
name: "firstFastRetry"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ExponentialBackoffWithJitter(int retryCount, long minBackoff, long maxBackoff, long deltaBackoff, boolean firstFastRetry)"
desc: "Constructor."
methods:
- uid: "com.microsoft.azure.sdk.iot.device.transport.ExponentialBackoffWithJitter.getRetryDecision(int,com.microsoft.azure.sdk.iot.device.exceptions.TransportException)"
fullName: "com.microsoft.azure.sdk.iot.device.transport.ExponentialBackoffWithJitter.getRetryDecision(int currentRetryCount, TransportException lastException)"
name: "getRetryDecision(int currentRetryCount, TransportException lastException)"
nameWithType: "ExponentialBackoffWithJitter.getRetryDecision(int currentRetryCount, TransportException lastException)"
summary: "Determines whether the operation should be retried and the interval until the next retry."
parameters:
- description: "the number of retries for the given operation"
name: "currentRetryCount"
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- name: "lastException"
type: "<xref href=\"com.microsoft.azure.sdk.iot.device.exceptions.TransportException?alt=com.microsoft.azure.sdk.iot.device.exceptions.TransportException&text=TransportException\" data-throw-if-not-resolved=\"False\" />"
syntax: "public RetryDecision getRetryDecision(int currentRetryCount, TransportException lastException)"
desc: "Determines whether the operation should be retried and the interval until the next retry."
returns:
description: "the retry decision."
type: "<xref href=\"com.microsoft.azure.sdk.iot.device.transport.RetryDecision?alt=com.microsoft.azure.sdk.iot.device.transport.RetryDecision&text=RetryDecision\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Represents a retry policy that performs exponential backoff with jitter retries."
implements:
- "<xref href=\"com.microsoft.azure.sdk.iot.device.transport.RetryPolicy?alt=com.microsoft.azure.sdk.iot.device.transport.RetryPolicy&text=RetryPolicy\" data-throw-if-not-resolved=\"False\" />"
metadata: {}
package: "com.microsoft.azure.sdk.iot.device.transport"
artifact: com.microsoft.azure.sdk.iot:iot-device-client:1.30.1