/
ServiceBusRetryOptions.xml
211 lines (211 loc) · 11.1 KB
/
ServiceBusRetryOptions.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
<Type Name="ServiceBusRetryOptions" FullName="Azure.Messaging.ServiceBus.ServiceBusRetryOptions">
<TypeSignature Language="C#" Value="public class ServiceBusRetryOptions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ServiceBusRetryOptions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.Messaging.ServiceBus.ServiceBusRetryOptions" />
<TypeSignature Language="VB.NET" Value="Public Class ServiceBusRetryOptions" />
<TypeSignature Language="F#" Value="type ServiceBusRetryOptions = class" />
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.1.2.0</AssemblyVersion>
<AssemblyVersion>7.2.0.0</AssemblyVersion>
<AssemblyVersion>7.2.1.0</AssemblyVersion>
<AssemblyVersion>7.3.0.0</AssemblyVersion>
<AssemblyVersion>7.4.0.0</AssemblyVersion>
<AssemblyVersion>7.5.0.0</AssemblyVersion>
<AssemblyVersion>7.5.1.0</AssemblyVersion>
<AssemblyVersion>7.6.0.0</AssemblyVersion>
<AssemblyVersion>7.7.0.0</AssemblyVersion>
<AssemblyVersion>7.8.0.0</AssemblyVersion>
<AssemblyVersion>7.8.1.0</AssemblyVersion>
<AssemblyVersion>7.9.0.0</AssemblyVersion>
<AssemblyVersion>7.10.0.0</AssemblyVersion>
<AssemblyVersion>7.11.0.0</AssemblyVersion>
<AssemblyVersion>7.11.1.0</AssemblyVersion>
<AssemblyVersion>7.12.0.0</AssemblyVersion>
<AssemblyVersion>7.13.0.0</AssemblyVersion>
<AssemblyVersion>7.13.1.0</AssemblyVersion>
<AssemblyVersion>7.14.0.0</AssemblyVersion>
<AssemblyVersion>7.15.0.0</AssemblyVersion>
<AssemblyVersion>7.16.0.0</AssemblyVersion>
<AssemblyVersion>7.16.1.0</AssemblyVersion>
<AssemblyVersion>7.16.2.0</AssemblyVersion>
<AssemblyVersion>7.17.0.0</AssemblyVersion>
<AssemblyVersion>7.17.1.0</AssemblyVersion>
<AssemblyVersion>7.17.2.0</AssemblyVersion>
<AssemblyVersion>7.17.3.0</AssemblyVersion>
<AssemblyVersion>7.17.4.0</AssemblyVersion>
<AssemblyVersion>7.17.5.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
The set of options that can be specified to influence how
retry attempts are made, and a failure is eligible to be retried.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ServiceBusRetryOptions ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Messaging.ServiceBus.ServiceBusRetryOptions.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.17.5.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CustomRetryPolicy">
<MemberSignature Language="C#" Value="public Azure.Messaging.ServiceBus.ServiceBusRetryPolicy CustomRetryPolicy { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Azure.Messaging.ServiceBus.ServiceBusRetryPolicy CustomRetryPolicy" />
<MemberSignature Language="DocId" Value="P:Azure.Messaging.ServiceBus.ServiceBusRetryOptions.CustomRetryPolicy" />
<MemberSignature Language="VB.NET" Value="Public Property CustomRetryPolicy As ServiceBusRetryPolicy" />
<MemberSignature Language="F#" Value="member this.CustomRetryPolicy : Azure.Messaging.ServiceBus.ServiceBusRetryPolicy with get, set" Usage="Azure.Messaging.ServiceBus.ServiceBusRetryOptions.CustomRetryPolicy" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.17.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Messaging.ServiceBus.ServiceBusRetryPolicy</ReturnType>
</ReturnValue>
<Docs>
<summary>
A custom retry policy to be used in place of the individual option values.
</summary>
<value>To be added.</value>
<remarks>
When populated, this custom policy will take precedence over the individual retry
options provided.
</remarks>
</Docs>
</Member>
<Member MemberName="Delay">
<MemberSignature Language="C#" Value="public TimeSpan Delay { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan Delay" />
<MemberSignature Language="DocId" Value="P:Azure.Messaging.ServiceBus.ServiceBusRetryOptions.Delay" />
<MemberSignature Language="VB.NET" Value="Public Property Delay As TimeSpan" />
<MemberSignature Language="F#" Value="member this.Delay : TimeSpan with get, set" Usage="Azure.Messaging.ServiceBus.ServiceBusRetryOptions.Delay" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.17.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>
The delay between retry attempts for a fixed approach or the delay
on which to base calculations for a backoff-based approach.
</summary>
<value>The default delay is 0.8 seconds.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">Occurs when the requested delay is not between 1 millisecond and 5 minutes (inclusive).</exception>
</Docs>
</Member>
<Member MemberName="MaxDelay">
<MemberSignature Language="C#" Value="public TimeSpan MaxDelay { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan MaxDelay" />
<MemberSignature Language="DocId" Value="P:Azure.Messaging.ServiceBus.ServiceBusRetryOptions.MaxDelay" />
<MemberSignature Language="VB.NET" Value="Public Property MaxDelay As TimeSpan" />
<MemberSignature Language="F#" Value="member this.MaxDelay : TimeSpan with get, set" Usage="Azure.Messaging.ServiceBus.ServiceBusRetryOptions.MaxDelay" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.17.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>
The maximum permissible delay between retry attempts.
</summary>
<value>The default maximum delay is 60 seconds.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">Occurs when the requested delay is negative.</exception>
</Docs>
</Member>
<Member MemberName="MaxRetries">
<MemberSignature Language="C#" Value="public int MaxRetries { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 MaxRetries" />
<MemberSignature Language="DocId" Value="P:Azure.Messaging.ServiceBus.ServiceBusRetryOptions.MaxRetries" />
<MemberSignature Language="VB.NET" Value="Public Property MaxRetries As Integer" />
<MemberSignature Language="F#" Value="member this.MaxRetries : int with get, set" Usage="Azure.Messaging.ServiceBus.ServiceBusRetryOptions.MaxRetries" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.17.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
The maximum number of retry attempts before considering the associated operation
to have failed.
</summary>
<value>The default retry limit is 3.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">Occurs when the requested number of retries is not between 0 and 100 (inclusive).</exception>
</Docs>
</Member>
<Member MemberName="Mode">
<MemberSignature Language="C#" Value="public Azure.Messaging.ServiceBus.ServiceBusRetryMode Mode { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Azure.Messaging.ServiceBus.ServiceBusRetryMode Mode" />
<MemberSignature Language="DocId" Value="P:Azure.Messaging.ServiceBus.ServiceBusRetryOptions.Mode" />
<MemberSignature Language="VB.NET" Value="Public Property Mode As ServiceBusRetryMode" />
<MemberSignature Language="F#" Value="member this.Mode : Azure.Messaging.ServiceBus.ServiceBusRetryMode with get, set" Usage="Azure.Messaging.ServiceBus.ServiceBusRetryOptions.Mode" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.17.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Messaging.ServiceBus.ServiceBusRetryMode</ReturnType>
</ReturnValue>
<Docs>
<summary>
The approach to use for calculating retry delays.
</summary>
<value>The default retry mode is <see cref="F:Azure.Messaging.ServiceBus.ServiceBusRetryMode.Exponential" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TryTimeout">
<MemberSignature Language="C#" Value="public TimeSpan TryTimeout { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan TryTimeout" />
<MemberSignature Language="DocId" Value="P:Azure.Messaging.ServiceBus.ServiceBusRetryOptions.TryTimeout" />
<MemberSignature Language="VB.NET" Value="Public Property TryTimeout As TimeSpan" />
<MemberSignature Language="F#" Value="member this.TryTimeout : TimeSpan with get, set" Usage="Azure.Messaging.ServiceBus.ServiceBusRetryOptions.TryTimeout" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.ServiceBus</AssemblyName>
<AssemblyVersion>7.17.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>
The maximum duration to wait for completion of a single attempt, whether the initial
attempt or a retry.
</summary>
<value>The default timeout is 60 seconds.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">Occurs when the requested timeout is negative.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">Occurs when the requested timeout is not between <see cref="F:System.TimeSpan.Zero" /> and 1 hour (inclusive).</exception>
</Docs>
</Member>
</Members>
</Type>