forked from Azure/azure-docs-sdk-dotnet
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathEventHubsRetryPolicy.xml
267 lines (267 loc) · 14.4 KB
/
EventHubsRetryPolicy.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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
<Type Name="EventHubsRetryPolicy" FullName="Azure.Messaging.EventHubs.EventHubsRetryPolicy">
<TypeSignature Language="C#" Value="public abstract class EventHubsRetryPolicy" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit EventHubsRetryPolicy extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.Messaging.EventHubs.EventHubsRetryPolicy" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class EventHubsRetryPolicy" />
<TypeSignature Language="F#" Value="type EventHubsRetryPolicy = class" />
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.4.0.0</AssemblyVersion>
<AssemblyVersion>5.4.1.0</AssemblyVersion>
<AssemblyVersion>5.5.0.0</AssemblyVersion>
<AssemblyVersion>5.6.0.0</AssemblyVersion>
<AssemblyVersion>5.6.1.0</AssemblyVersion>
<AssemblyVersion>5.6.2.0</AssemblyVersion>
<AssemblyVersion>5.7.0.0</AssemblyVersion>
<AssemblyVersion>5.7.1.0</AssemblyVersion>
<AssemblyVersion>5.7.2.0</AssemblyVersion>
<AssemblyVersion>5.7.3.0</AssemblyVersion>
<AssemblyVersion>5.7.4.0</AssemblyVersion>
<AssemblyVersion>5.7.5.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
An abstract representation of a policy to govern retrying of messaging operations.
</summary>
<remarks>
It is recommended that developers without advanced needs not implement custom retry
policies but instead configure the default policy by specifying the desired set of
retry options when creating one of the Event Hubs clients.
</remarks>
<altmember cref="T:Azure.Messaging.EventHubs.EventHubsRetryOptions" />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected EventHubsRetryPolicy ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.EventHubsRetryPolicy.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.4.0.0</AssemblyVersion>
<AssemblyVersion>5.4.1.0</AssemblyVersion>
<AssemblyVersion>5.5.0.0</AssemblyVersion>
<AssemblyVersion>5.6.0.0</AssemblyVersion>
<AssemblyVersion>5.6.1.0</AssemblyVersion>
<AssemblyVersion>5.6.2.0</AssemblyVersion>
<AssemblyVersion>5.7.0.0</AssemblyVersion>
<AssemblyVersion>5.7.1.0</AssemblyVersion>
<AssemblyVersion>5.7.2.0</AssemblyVersion>
<AssemblyVersion>5.7.3.0</AssemblyVersion>
<AssemblyVersion>5.7.4.0</AssemblyVersion>
<AssemblyVersion>5.7.5.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CalculateRetryDelay">
<MemberSignature Language="C#" Value="public abstract TimeSpan? CalculateRetryDelay (Exception lastException, int attemptCount);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance valuetype System.Nullable`1<valuetype System.TimeSpan> CalculateRetryDelay(class System.Exception lastException, int32 attemptCount) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.EventHubsRetryPolicy.CalculateRetryDelay(System.Exception,System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function CalculateRetryDelay (lastException As Exception, attemptCount As Integer) As Nullable(Of TimeSpan)" />
<MemberSignature Language="F#" Value="abstract member CalculateRetryDelay : Exception * int -> Nullable<TimeSpan>" Usage="eventHubsRetryPolicy.CalculateRetryDelay (lastException, attemptCount)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.4.0.0</AssemblyVersion>
<AssemblyVersion>5.4.1.0</AssemblyVersion>
<AssemblyVersion>5.5.0.0</AssemblyVersion>
<AssemblyVersion>5.6.0.0</AssemblyVersion>
<AssemblyVersion>5.6.1.0</AssemblyVersion>
<AssemblyVersion>5.6.2.0</AssemblyVersion>
<AssemblyVersion>5.7.0.0</AssemblyVersion>
<AssemblyVersion>5.7.1.0</AssemblyVersion>
<AssemblyVersion>5.7.2.0</AssemblyVersion>
<AssemblyVersion>5.7.3.0</AssemblyVersion>
<AssemblyVersion>5.7.4.0</AssemblyVersion>
<AssemblyVersion>5.7.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.TimeSpan></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="lastException" Type="System.Exception" />
<Parameter Name="attemptCount" Type="System.Int32" />
</Parameters>
<Docs>
<param name="lastException">The last exception that was observed for the operation to be retried.</param>
<param name="attemptCount">The number of total attempts that have been made, including the initial attempt before any retries.</param>
<summary>
Calculates the amount of time to wait before another attempt should be made.
</summary>
<returns>The amount of time to delay before retrying the associated operation; if <c>null</c>, then the operation is no longer eligible to be retried.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CalculateTryTimeout">
<MemberSignature Language="C#" Value="public abstract TimeSpan CalculateTryTimeout (int attemptCount);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance valuetype System.TimeSpan CalculateTryTimeout(int32 attemptCount) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.EventHubsRetryPolicy.CalculateTryTimeout(System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function CalculateTryTimeout (attemptCount As Integer) As TimeSpan" />
<MemberSignature Language="F#" Value="abstract member CalculateTryTimeout : int -> TimeSpan" Usage="eventHubsRetryPolicy.CalculateTryTimeout attemptCount" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.4.0.0</AssemblyVersion>
<AssemblyVersion>5.4.1.0</AssemblyVersion>
<AssemblyVersion>5.5.0.0</AssemblyVersion>
<AssemblyVersion>5.6.0.0</AssemblyVersion>
<AssemblyVersion>5.6.1.0</AssemblyVersion>
<AssemblyVersion>5.6.2.0</AssemblyVersion>
<AssemblyVersion>5.7.0.0</AssemblyVersion>
<AssemblyVersion>5.7.1.0</AssemblyVersion>
<AssemblyVersion>5.7.2.0</AssemblyVersion>
<AssemblyVersion>5.7.3.0</AssemblyVersion>
<AssemblyVersion>5.7.4.0</AssemblyVersion>
<AssemblyVersion>5.7.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="attemptCount" Type="System.Int32" />
</Parameters>
<Docs>
<param name="attemptCount">The number of total attempts that have been made, including the initial attempt before any retries.</param>
<summary>
Calculates the amount of time to allow the current attempt for an operation to
complete before considering it to be timed out.
</summary>
<returns>The amount of time to allow for an operation to complete.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public override bool Equals (object obj);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.EventHubsRetryPolicy.Equals(System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function Equals (obj As Object) As Boolean" />
<MemberSignature Language="F#" Value="override this.Equals : obj -> bool" Usage="eventHubsRetryPolicy.Equals obj" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.4.0.0</AssemblyVersion>
<AssemblyVersion>5.4.1.0</AssemblyVersion>
<AssemblyVersion>5.5.0.0</AssemblyVersion>
<AssemblyVersion>5.6.0.0</AssemblyVersion>
<AssemblyVersion>5.6.1.0</AssemblyVersion>
<AssemblyVersion>5.6.2.0</AssemblyVersion>
<AssemblyVersion>5.7.0.0</AssemblyVersion>
<AssemblyVersion>5.7.1.0</AssemblyVersion>
<AssemblyVersion>5.7.2.0</AssemblyVersion>
<AssemblyVersion>5.7.3.0</AssemblyVersion>
<AssemblyVersion>5.7.4.0</AssemblyVersion>
<AssemblyVersion>5.7.5.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="obj" Type="System.Object" />
</Parameters>
<Docs>
<param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param>
<summary>
Determines whether the specified <see cref="T:System.Object" /> is equal to this instance.
</summary>
<returns>
<c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance; otherwise, <c>false</c>.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetHashCode">
<MemberSignature Language="C#" Value="public override int GetHashCode ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.EventHubsRetryPolicy.GetHashCode" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetHashCode () As Integer" />
<MemberSignature Language="F#" Value="override this.GetHashCode : unit -> int" Usage="eventHubsRetryPolicy.GetHashCode " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.4.0.0</AssemblyVersion>
<AssemblyVersion>5.4.1.0</AssemblyVersion>
<AssemblyVersion>5.5.0.0</AssemblyVersion>
<AssemblyVersion>5.6.0.0</AssemblyVersion>
<AssemblyVersion>5.6.1.0</AssemblyVersion>
<AssemblyVersion>5.6.2.0</AssemblyVersion>
<AssemblyVersion>5.7.0.0</AssemblyVersion>
<AssemblyVersion>5.7.1.0</AssemblyVersion>
<AssemblyVersion>5.7.2.0</AssemblyVersion>
<AssemblyVersion>5.7.3.0</AssemblyVersion>
<AssemblyVersion>5.7.4.0</AssemblyVersion>
<AssemblyVersion>5.7.5.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Returns a hash code for this instance.
</summary>
<returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.EventHubsRetryPolicy.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="eventHubsRetryPolicy.ToString " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.4.0.0</AssemblyVersion>
<AssemblyVersion>5.4.1.0</AssemblyVersion>
<AssemblyVersion>5.5.0.0</AssemblyVersion>
<AssemblyVersion>5.6.0.0</AssemblyVersion>
<AssemblyVersion>5.6.1.0</AssemblyVersion>
<AssemblyVersion>5.6.2.0</AssemblyVersion>
<AssemblyVersion>5.7.0.0</AssemblyVersion>
<AssemblyVersion>5.7.1.0</AssemblyVersion>
<AssemblyVersion>5.7.2.0</AssemblyVersion>
<AssemblyVersion>5.7.3.0</AssemblyVersion>
<AssemblyVersion>5.7.4.0</AssemblyVersion>
<AssemblyVersion>5.7.5.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Converts the instance to string representation.
</summary>
<returns>A <see cref="T:System.String" /> that represents this instance.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>