-
Notifications
You must be signed in to change notification settings - Fork 261
/
ProvisioningClientRetryPolicyBase.xml
130 lines (130 loc) · 7.8 KB
/
ProvisioningClientRetryPolicyBase.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
<Type Name="ProvisioningClientRetryPolicyBase" FullName="Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientRetryPolicyBase">
<TypeSignature Language="C#" Value="public abstract class ProvisioningClientRetryPolicyBase : Microsoft.Azure.Devices.Provisioning.Client.IProvisioningClientRetryPolicy" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit ProvisioningClientRetryPolicyBase extends System.Object implements class Microsoft.Azure.Devices.Provisioning.Client.IProvisioningClientRetryPolicy" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientRetryPolicyBase" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class ProvisioningClientRetryPolicyBase
Implements IProvisioningClientRetryPolicy" />
<TypeSignature Language="F#" Value="type ProvisioningClientRetryPolicyBase = class
 interface IProvisioningClientRetryPolicy" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.Azure.Devices.Provisioning.Client.IProvisioningClientRetryPolicy</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
A base retry policy.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ProvisioningClientRetryPolicyBase (uint maxRetries);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(unsigned int32 maxRetries) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientRetryPolicyBase.#ctor(System.UInt32)" />
<MemberSignature Language="VB.NET" Value="Protected Sub New (maxRetries As UInteger)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientRetryPolicyBase : uint32 -> Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientRetryPolicyBase" Usage="new Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientRetryPolicyBase maxRetries" />
<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" />
</Parameters>
<Docs>
<param name="maxRetries">The maximum number of retries; use a negative value for infinite retries.</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="maxRetries" /> is negative.</exception>
</Docs>
</Member>
<Member MemberName="MaxRetries">
<MemberSignature Language="C#" Value="protected uint MaxRetries { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance unsigned int32 MaxRetries" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientRetryPolicyBase.MaxRetries" />
<MemberSignature Language="VB.NET" Value="Protected ReadOnly Property MaxRetries As UInteger" />
<MemberSignature Language="F#" Value="member this.MaxRetries : uint32" Usage="Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientRetryPolicyBase.MaxRetries" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>
The maximum number of retries
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ShouldRetry">
<MemberSignature Language="C#" Value="public virtual bool ShouldRetry (uint currentRetryCount, Exception lastException, out TimeSpan retryDelay);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool ShouldRetry(unsigned int32 currentRetryCount, class System.Exception lastException, [out] valuetype System.TimeSpan& retryDelay) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientRetryPolicyBase.ShouldRetry(System.UInt32,System.Exception,System.TimeSpan@)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function ShouldRetry (currentRetryCount As UInteger, lastException As Exception, ByRef retryDelay As TimeSpan) As Boolean" />
<MemberSignature Language="F#" Value="abstract member ShouldRetry : uint32 * Exception * TimeSpan -> bool
override this.ShouldRetry : uint32 * Exception * TimeSpan -> bool" Usage="provisioningClientRetryPolicyBase.ShouldRetry (currentRetryCount, lastException, retryDelay)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Azure.Devices.Provisioning.Client.IProvisioningClientRetryPolicy.ShouldRetry(System.UInt32,System.Exception,System.TimeSpan@)</InterfaceMember>
</Implements>
<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="retryDelay" Type="System.TimeSpan" RefType="out" />
</Parameters>
<Docs>
<param name="currentRetryCount">To be added.</param>
<param name="lastException">To be added.</param>
<param name="retryDelay">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="UpdateWithJitter">
<MemberSignature Language="C#" Value="protected TimeSpan UpdateWithJitter (double baseTimeMs);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig instance valuetype System.TimeSpan UpdateWithJitter(float64 baseTimeMs) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientRetryPolicyBase.UpdateWithJitter(System.Double)" />
<MemberSignature Language="VB.NET" Value="Protected Function UpdateWithJitter (baseTimeMs As Double) As TimeSpan" />
<MemberSignature Language="F#" Value="member this.UpdateWithJitter : double -> TimeSpan" Usage="provisioningClientRetryPolicyBase.UpdateWithJitter baseTimeMs" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="baseTimeMs" Type="System.Double" />
</Parameters>
<Docs>
<param name="baseTimeMs">To be added.</param>
<summary>
Gets jitter between 95% and 105% of the base time.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>