-
Notifications
You must be signed in to change notification settings - Fork 255
/
ProvisioningClientFixedDelayRetryPolicy.xml
82 lines (82 loc) · 5.84 KB
/
ProvisioningClientFixedDelayRetryPolicy.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
<Type Name="ProvisioningClientFixedDelayRetryPolicy" FullName="Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientFixedDelayRetryPolicy">
<TypeSignature Language="C#" Value="public class ProvisioningClientFixedDelayRetryPolicy : Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientRetryPolicyBase" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ProvisioningClientFixedDelayRetryPolicy extends Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientRetryPolicyBase" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientFixedDelayRetryPolicy" />
<TypeSignature Language="VB.NET" Value="Public Class ProvisioningClientFixedDelayRetryPolicy
Inherits ProvisioningClientRetryPolicyBase" />
<TypeSignature Language="F#" Value="type ProvisioningClientFixedDelayRetryPolicy = 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 a fixed 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 ProvisioningClientFixedDelayRetryPolicy (uint maxRetries, TimeSpan fixedDelay, bool useJitter = true);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(unsigned int32 maxRetries, valuetype System.TimeSpan fixedDelay, bool useJitter) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientFixedDelayRetryPolicy.#ctor(System.UInt32,System.TimeSpan,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (maxRetries As UInteger, fixedDelay As TimeSpan, Optional useJitter As Boolean = true)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientFixedDelayRetryPolicy : uint32 * TimeSpan * bool -> Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientFixedDelayRetryPolicy" Usage="new Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientFixedDelayRetryPolicy (maxRetries, fixedDelay, 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="fixedDelay" 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="fixedDelay">The fixed delay to wait between retries.</param>
<param name="useJitter">Whether to add a small, random adjustment to the retry delay to avoid synchronicity in retrying clients.</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="fixedDelay" /> is negative.</exception>
</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.ProvisioningClientFixedDelayRetryPolicy.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="provisioningClientFixedDelayRetryPolicy.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>
</Members>
</Type>