-
Notifications
You must be signed in to change notification settings - Fork 256
/
ProvisioningClientIncrementalDelayRetryPolicy.xml
152 lines (152 loc) · 9.94 KB
/
ProvisioningClientIncrementalDelayRetryPolicy.xml
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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
<Type Name="ProvisioningClientIncrementalDelayRetryPolicy" FullName="Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientIncrementalDelayRetryPolicy">
<TypeSignature Language="C#" Value="public class ProvisioningClientIncrementalDelayRetryPolicy : Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientRetryPolicyBase" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ProvisioningClientIncrementalDelayRetryPolicy extends Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientRetryPolicyBase" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientIncrementalDelayRetryPolicy" />
<TypeSignature Language="VB.NET" Value="Public Class ProvisioningClientIncrementalDelayRetryPolicy
Inherits ProvisioningClientRetryPolicyBase" />
<TypeSignature Language="F#" Value="type ProvisioningClientIncrementalDelayRetryPolicy = class
 inherit ProvisioningClientRetryPolicyBase" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientRetryPolicyBase</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Represents a retry policy that performs a specified number of retries, using an incrementally increasing retry delay with jitter.
</summary>
<remarks>
Jitter can change the delay from 95% to 105% of the calculated time.
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ProvisioningClientIncrementalDelayRetryPolicy (uint maxRetries, TimeSpan delayIncrement, TimeSpan maxDelay, bool useJitter = true);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(unsigned int32 maxRetries, valuetype System.TimeSpan delayIncrement, valuetype System.TimeSpan maxDelay, bool useJitter) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientIncrementalDelayRetryPolicy.#ctor(System.UInt32,System.TimeSpan,System.TimeSpan,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (maxRetries As UInteger, delayIncrement As TimeSpan, maxDelay As TimeSpan, Optional useJitter As Boolean = true)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientIncrementalDelayRetryPolicy : uint32 * TimeSpan * TimeSpan * bool -> Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientIncrementalDelayRetryPolicy" Usage="new Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientIncrementalDelayRetryPolicy (maxRetries, delayIncrement, maxDelay, useJitter)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="maxRetries" Type="System.UInt32" />
<Parameter Name="delayIncrement" Type="System.TimeSpan" />
<Parameter Name="maxDelay" Type="System.TimeSpan" />
<Parameter Name="useJitter" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="maxRetries">The maximum number of retry attempts; use 0 for infinite retries.</param>
<param name="delayIncrement">The amount to increment the delay on each additional count of retry.</param>
<param name="maxDelay">The maximum amount of time to wait between retries.</param>
<param name="useJitter">Whether to add a small, random adjustment to the retry delay to avoid synchronicity in clients retrying.</param>
<summary>
Creates an instance of this class.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">
Throw if the value of <paramref name="delayIncrement" /> or <paramref name="maxDelay" /> is negative.
</exception>
</Docs>
</Member>
<Member MemberName="DelayIncrement">
<MemberSignature Language="C#" Value="protected internal TimeSpan DelayIncrement { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan DelayIncrement" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientIncrementalDelayRetryPolicy.DelayIncrement" />
<MemberSignature Language="VB.NET" Value="Protected Friend ReadOnly Property DelayIncrement As TimeSpan" />
<MemberSignature Language="F#" Value="member this.DelayIncrement : TimeSpan" Usage="Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientIncrementalDelayRetryPolicy.DelayIncrement" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>
The amount to increment the delay on each additional count of retry.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxDelay">
<MemberSignature Language="C#" Value="protected internal TimeSpan MaxDelay { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan MaxDelay" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientIncrementalDelayRetryPolicy.MaxDelay" />
<MemberSignature Language="VB.NET" Value="Protected Friend ReadOnly Property MaxDelay As TimeSpan" />
<MemberSignature Language="F#" Value="member this.MaxDelay : TimeSpan" Usage="Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientIncrementalDelayRetryPolicy.MaxDelay" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>
The maximum amount of time to wait between retries.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ShouldRetry">
<MemberSignature Language="C#" Value="public override bool ShouldRetry (uint currentRetryCount, Exception lastException, out TimeSpan retryInterval);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool ShouldRetry(unsigned int32 currentRetryCount, class System.Exception lastException, [out] valuetype System.TimeSpan& retryInterval) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientIncrementalDelayRetryPolicy.ShouldRetry(System.UInt32,System.Exception,System.TimeSpan@)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ShouldRetry (currentRetryCount As UInteger, lastException As Exception, ByRef retryInterval As TimeSpan) As Boolean" />
<MemberSignature Language="F#" Value="override this.ShouldRetry : uint32 * Exception * TimeSpan -> bool" Usage="provisioningClientIncrementalDelayRetryPolicy.ShouldRetry (currentRetryCount, lastException, retryInterval)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="currentRetryCount" Type="System.UInt32" />
<Parameter Name="lastException" Type="System.Exception" />
<Parameter Name="retryInterval" Type="System.TimeSpan" RefType="out" />
</Parameters>
<Docs>
<param name="currentRetryCount">How many times the operation has been retried.</param>
<param name="lastException">Operation exception.</param>
<param name="retryInterval">Next retry should be performed after this time interval.</param>
<summary>
Returns true if, based on the parameters, the operation should be retried.
</summary>
<returns>True if the operation should be retried, false otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UseJitter">
<MemberSignature Language="C#" Value="protected internal bool UseJitter { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool UseJitter" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientIncrementalDelayRetryPolicy.UseJitter" />
<MemberSignature Language="VB.NET" Value="Protected Friend ReadOnly Property UseJitter As Boolean" />
<MemberSignature Language="F#" Value="member this.UseJitter : bool" Usage="Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientIncrementalDelayRetryPolicy.UseJitter" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Whether to add a small, random adjustment to the retry delay to avoid synchronicity in clients retrying.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>