-
Notifications
You must be signed in to change notification settings - Fork 254
/
RetryExponential.xml
197 lines (197 loc) · 11.6 KB
/
RetryExponential.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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
<Type Name="RetryExponential" FullName="Microsoft.Azure.ServiceBus.RetryExponential">
<TypeSignature Language="C#" Value="public sealed class RetryExponential : Microsoft.Azure.ServiceBus.RetryPolicy" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit RetryExponential extends Microsoft.Azure.ServiceBus.RetryPolicy" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.ServiceBus.RetryExponential" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class RetryExponential
Inherits RetryPolicy" />
<TypeSignature Language="F#" Value="type RetryExponential = class
 inherit RetryPolicy" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.1.3.0</AssemblyVersion>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Azure.ServiceBus.RetryPolicy</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
RetryPolicy implementation where the delay between retries will grow in a staggered exponential manner.
RetryIntervals will be computed using a retryFactor which is a function of deltaBackOff (MaximumBackoff - MinimumBackoff) and MaximumRetryCount.
<remarks>RetryPolicy will not be applied when an ambient transaction is found.</remarks></summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RetryExponential (TimeSpan minimumBackoff, TimeSpan maximumBackoff, int maximumRetryCount);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.TimeSpan minimumBackoff, valuetype System.TimeSpan maximumBackoff, int32 maximumRetryCount) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.ServiceBus.RetryExponential.#ctor(System.TimeSpan,System.TimeSpan,System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (minimumBackoff As TimeSpan, maximumBackoff As TimeSpan, maximumRetryCount As Integer)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.ServiceBus.RetryExponential : TimeSpan * TimeSpan * int -> Microsoft.Azure.ServiceBus.RetryExponential" Usage="new Microsoft.Azure.ServiceBus.RetryExponential (minimumBackoff, maximumBackoff, maximumRetryCount)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="minimumBackoff" Type="System.TimeSpan" />
<Parameter Name="maximumBackoff" Type="System.TimeSpan" />
<Parameter Name="maximumRetryCount" Type="System.Int32" />
</Parameters>
<Docs>
<param name="maximumRetryCount">To be added.</param>
<param name="minimumBackoff">Minimum backoff interval.</param>
<param name="maximumBackoff">Maximum backoff interval.</param>
<summary>
Returns a new RetryExponential retry policy object.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RetryExponential (TimeSpan minimumBackoff, TimeSpan maximumBackoff, TimeSpan deltaBackoff, int maxRetryCount);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.TimeSpan minimumBackoff, valuetype System.TimeSpan maximumBackoff, valuetype System.TimeSpan deltaBackoff, int32 maxRetryCount) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.ServiceBus.RetryExponential.#ctor(System.TimeSpan,System.TimeSpan,System.TimeSpan,System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (minimumBackoff As TimeSpan, maximumBackoff As TimeSpan, deltaBackoff As TimeSpan, maxRetryCount As Integer)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.ServiceBus.RetryExponential : TimeSpan * TimeSpan * TimeSpan * int -> Microsoft.Azure.ServiceBus.RetryExponential" Usage="new Microsoft.Azure.ServiceBus.RetryExponential (minimumBackoff, maximumBackoff, deltaBackoff, maxRetryCount)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="minimumBackoff" Type="System.TimeSpan" />
<Parameter Name="maximumBackoff" Type="System.TimeSpan" />
<Parameter Name="deltaBackoff" Type="System.TimeSpan" />
<Parameter Name="maxRetryCount" Type="System.Int32" />
</Parameters>
<Docs>
<param name="maxRetryCount">To be added.</param>
<param name="minimumBackoff">Minimum backoff interval.</param>
<param name="maximumBackoff">Maximum backoff interval.</param>
<param name="deltaBackoff">Delta backoff interval.</param>
<summary>
Returns a new RetryExponential retry policy object.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DeltaBackoff">
<MemberSignature Language="C#" Value="public TimeSpan DeltaBackoff { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan DeltaBackoff" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.ServiceBus.RetryExponential.DeltaBackoff" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property DeltaBackoff As TimeSpan" />
<MemberSignature Language="F#" Value="member this.DeltaBackoff : TimeSpan" Usage="Microsoft.Azure.ServiceBus.RetryExponential.DeltaBackoff" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the backoff interval associated with the retry.
</summary>
<value>The backoff interval associated with the retry.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaximumBackoff">
<MemberSignature Language="C#" Value="public TimeSpan MaximumBackoff { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan MaximumBackoff" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.ServiceBus.RetryExponential.MaximumBackoff" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property MaximumBackoff As TimeSpan" />
<MemberSignature Language="F#" Value="member this.MaximumBackoff : TimeSpan" Usage="Microsoft.Azure.ServiceBus.RetryExponential.MaximumBackoff" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the maximum backoff interval.
</summary>
<value>The maximum backoff interval.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxRetryCount">
<MemberSignature Language="C#" Value="public int MaxRetryCount { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 MaxRetryCount" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.ServiceBus.RetryExponential.MaxRetryCount" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property MaxRetryCount As Integer" />
<MemberSignature Language="F#" Value="member this.MaxRetryCount : int" Usage="Microsoft.Azure.ServiceBus.RetryExponential.MaxRetryCount" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the maximum number of allowed retries.
</summary>
<value>The maximum number of allowed retries.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MinimalBackoff">
<MemberSignature Language="C#" Value="public TimeSpan MinimalBackoff { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan MinimalBackoff" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.ServiceBus.RetryExponential.MinimalBackoff" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property MinimalBackoff As TimeSpan" />
<MemberSignature Language="F#" Value="member this.MinimalBackoff : TimeSpan" Usage="Microsoft.Azure.ServiceBus.RetryExponential.MinimalBackoff" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>
Minimum backoff interval.
</summary>
<value>The minimum backoff interval.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnShouldRetry">
<MemberSignature Language="C#" Value="protected override bool OnShouldRetry (TimeSpan remainingTime, int currentRetryCount, out TimeSpan retryInterval);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance bool OnShouldRetry(valuetype System.TimeSpan remainingTime, int32 currentRetryCount, [out] valuetype System.TimeSpan& retryInterval) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.ServiceBus.RetryExponential.OnShouldRetry(System.TimeSpan,System.Int32,System.TimeSpan@)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function OnShouldRetry (remainingTime As TimeSpan, currentRetryCount As Integer, ByRef retryInterval As TimeSpan) As Boolean" />
<MemberSignature Language="F#" Value="override this.OnShouldRetry : TimeSpan * int * TimeSpan -> bool" Usage="retryExponential.OnShouldRetry (remainingTime, currentRetryCount, retryInterval)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="remainingTime" Type="System.TimeSpan" />
<Parameter Name="currentRetryCount" Type="System.Int32" />
<Parameter Name="retryInterval" Type="System.TimeSpan" RefType="out" />
</Parameters>
<Docs>
<param name="remainingTime">The remaining time before the timeout expires.</param>
<param name="currentRetryCount">The number of attempts that have been processed.</param>
<param name="retryInterval">The amount of time to delay before retry.</param>
<summary>
Called to see if a retry should be performed.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>