-
Notifications
You must be signed in to change notification settings - Fork 255
/
RetryPolicy.xml
219 lines (218 loc) · 12.5 KB
/
RetryPolicy.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
<Type Name="RetryPolicy" FullName="Microsoft.ServiceBus.RetryPolicy">
<TypeSignature Language="C#" Value="public abstract class RetryPolicy" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit RetryPolicy extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.ServiceBus.RetryPolicy" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class RetryPolicy" />
<TypeSignature Language="F#" Value="type RetryPolicy = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Represents an abstraction for retrying messaging operations. Users should not
implement this class, and instead should use one of the provided implementations.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="Clone">
<MemberSignature Language="C#" Value="public abstract Microsoft.ServiceBus.RetryPolicy Clone ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.ServiceBus.RetryPolicy Clone() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.RetryPolicy.Clone" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function Clone () As RetryPolicy" />
<MemberSignature Language="F#" Value="abstract member Clone : unit -> Microsoft.ServiceBus.RetryPolicy" Usage="retryPolicy.Clone " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.RetryPolicy</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Creates a new copy of the current <see cref="T:Microsoft.ServiceBus.RetryPolicy" /> and clones it into a new instance.</summary>
<returns>A new copy of <see cref="T:Microsoft.ServiceBus.RetryPolicy" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Default">
<MemberSignature Language="C#" Value="public static Microsoft.ServiceBus.RetryPolicy Default { get; }" />
<MemberSignature Language="ILAsm" Value=".property class Microsoft.ServiceBus.RetryPolicy Default" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.RetryPolicy.Default" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property Default As RetryPolicy" />
<MemberSignature Language="F#" Value="static member Default : Microsoft.ServiceBus.RetryPolicy" Usage="Microsoft.ServiceBus.RetryPolicy.Default" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.RetryPolicy</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets an instance of the <see cref="T:Microsoft.ServiceBus.RetryExponential" /> retry policy, which provides a default setup of exponentially
increasing retry intervals for messaging operations. Each time this property is accessed, a new instance is created.
</summary>
<value>The default policy associated with the policy.</value>
<remarks>This property is effectively creating the following instance.
<code>
var policy = new RetryExponential(
TimeSpan.Zero,
TimeSpan.FromSeconds(30),
10);
</code>
It is important to note that the retry policy should always
honor the <seealso cref="P:Microsoft.ServiceBus.Messaging.ClientEntity.OperationTimeout" /> so that
retry will terminate if the next retry interval will exceed the operation time.
</remarks>
</Docs>
</Member>
<Member MemberName="IsRetryableException">
<MemberSignature Language="C#" Value="protected abstract bool IsRetryableException (Exception lastException);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance bool IsRetryableException(class System.Exception lastException) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.RetryPolicy.IsRetryableException(System.Exception)" />
<MemberSignature Language="VB.NET" Value="Protected MustOverride Function IsRetryableException (lastException As Exception) As Boolean" />
<MemberSignature Language="F#" Value="abstract member IsRetryableException : Exception -> bool" Usage="retryPolicy.IsRetryableException lastException" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="lastException" Type="System.Exception" />
</Parameters>
<Docs>
<param name="lastException">The latest occurred exception.</param>
<summary>Determines whether it is permissible to retry after the specified exception.</summary>
<returns>If this method returns false, no retry occurs. Otherwise, the
<see cref="M:Microsoft.ServiceBus.RetryPolicy.OnShouldRetry(System.TimeSpan,System.Int32,System.TimeSpan@)" /> method determines when to retry.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="NoRetry">
<MemberSignature Language="C#" Value="public static Microsoft.ServiceBus.RetryPolicy NoRetry { get; }" />
<MemberSignature Language="ILAsm" Value=".property class Microsoft.ServiceBus.RetryPolicy NoRetry" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.RetryPolicy.NoRetry" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property NoRetry As RetryPolicy" />
<MemberSignature Language="F#" Value="static member NoRetry : Microsoft.ServiceBus.RetryPolicy" Usage="Microsoft.ServiceBus.RetryPolicy.NoRetry" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.RetryPolicy</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets an instance of the <see cref="P:Microsoft.ServiceBus.RetryPolicy.NoRetry" /> retry policy, which effectively disables retries.
Each time this property is accessed, a new instance is returned.
</summary>
<value>A retry policy that performs no retries.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnShouldRetry">
<MemberSignature Language="C#" Value="protected abstract bool OnShouldRetry (TimeSpan remainingTime, int currentRetryCount, out TimeSpan retryInterval);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance bool OnShouldRetry(valuetype System.TimeSpan remainingTime, int32 currentRetryCount, [out] valuetype System.TimeSpan& retryInterval) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.RetryPolicy.OnShouldRetry(System.TimeSpan,System.Int32,System.TimeSpan@)" />
<MemberSignature Language="VB.NET" Value="Protected MustOverride Function OnShouldRetry (remainingTime As TimeSpan, currentRetryCount As Integer, ByRef retryInterval As TimeSpan) As Boolean" />
<MemberSignature Language="F#" Value="abstract member OnShouldRetry : TimeSpan * int * TimeSpan -> bool" Usage="retryPolicy.OnShouldRetry (remainingTime, currentRetryCount, retryInterval)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.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.</param>
<param name="currentRetryCount">The total number of retries.</param>
<param name="retryInterval">The retry interval.</param>
<summary>Calculates the retry interval for the retry policy.</summary>
<returns>If this method returns true, the retry operation occurs after the
thread becomes idle for an amount of time equal to <paramref name="retryInterval" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ResetServerBusyInternal">
<MemberSignature Language="C#" Value="protected virtual void ResetServerBusyInternal ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void ResetServerBusyInternal() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.RetryPolicy.ResetServerBusyInternal" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Sub ResetServerBusyInternal ()" />
<MemberSignature Language="F#" Value="abstract member ResetServerBusyInternal : unit -> unit
override this.ResetServerBusyInternal : unit -> unit" Usage="retryPolicy.ResetServerBusyInternal " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary />
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SetServerBusy">
<MemberSignature Language="C#" Value="protected void SetServerBusy (string exceptionMessage);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig instance void SetServerBusy(string exceptionMessage) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.RetryPolicy.SetServerBusy(System.String)" />
<MemberSignature Language="VB.NET" Value="Protected Sub SetServerBusy (exceptionMessage As String)" />
<MemberSignature Language="F#" Value="member this.SetServerBusy : string -> unit" Usage="retryPolicy.SetServerBusy exceptionMessage" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="exceptionMessage" Type="System.String" />
</Parameters>
<Docs>
<param name="exceptionMessage" />
<summary />
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SetServerBusyInternal">
<MemberSignature Language="C#" Value="protected virtual void SetServerBusyInternal ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void SetServerBusyInternal() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.RetryPolicy.SetServerBusyInternal" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Sub SetServerBusyInternal ()" />
<MemberSignature Language="F#" Value="abstract member SetServerBusyInternal : unit -> unit
override this.SetServerBusyInternal : unit -> unit" Usage="retryPolicy.SetServerBusyInternal " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary />
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>