-
Notifications
You must be signed in to change notification settings - Fork 256
/
ExponentialRetryPolicy.xml
199 lines (199 loc) · 12.1 KB
/
ExponentialRetryPolicy.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
<Type Name="ExponentialRetryPolicy" FullName="Microsoft.ServiceFabric.Services.Communication.Client.ExponentialRetryPolicy">
<TypeSignature Language="C#" Value="public class ExponentialRetryPolicy : Microsoft.ServiceFabric.Services.Communication.Client.IRetryPolicy" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ExponentialRetryPolicy extends System.Object implements class Microsoft.ServiceFabric.Services.Communication.Client.IRetryPolicy" />
<TypeSignature Language="DocId" Value="T:Microsoft.ServiceFabric.Services.Communication.Client.ExponentialRetryPolicy" />
<TypeSignature Language="VB.NET" Value="Public Class ExponentialRetryPolicy
Implements IRetryPolicy" />
<TypeSignature Language="F#" Value="type ExponentialRetryPolicy = class
 interface IRetryPolicy" />
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.ServiceFabric.Services.Communication.Client.IRetryPolicy</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
Specifies the exponential backoff policy for retrying requests on exceptions in the communication channel between
client and service replicas.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ExponentialRetryPolicy (int defaultMaxRetryCount, TimeSpan clientRetryTimeout);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 defaultMaxRetryCount, valuetype System.TimeSpan clientRetryTimeout) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Services.Communication.Client.ExponentialRetryPolicy.#ctor(System.Int32,System.TimeSpan)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (defaultMaxRetryCount As Integer, clientRetryTimeout As TimeSpan)" />
<MemberSignature Language="F#" Value="new Microsoft.ServiceFabric.Services.Communication.Client.ExponentialRetryPolicy : int * TimeSpan -> Microsoft.ServiceFabric.Services.Communication.Client.ExponentialRetryPolicy" Usage="new Microsoft.ServiceFabric.Services.Communication.Client.ExponentialRetryPolicy (defaultMaxRetryCount, clientRetryTimeout)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="defaultMaxRetryCount" Type="System.Int32" />
<Parameter Name="clientRetryTimeout" Type="System.TimeSpan" />
</Parameters>
<Docs>
<param name="defaultMaxRetryCount">
Specifies the maximum number of times to retry.
</param>
<param name="clientRetryTimeout">Specifies the max timeout for the client side retry logic</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.ServiceFabric.Services.Communication.Client.ExponentialRetryPolicy" /> class with the supplied settings.
and the default values for the other retry settings.
The default values for maxRetryJitterForTransientErrors, maxRetryJitterForNonTransientErrors
are 2 seconds. The default value for MaxRetryCount is 10.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="BaseRetryDelay">
<MemberSignature Language="C#" Value="public TimeSpan BaseRetryDelay { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan BaseRetryDelay" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceFabric.Services.Communication.Client.ExponentialRetryPolicy.BaseRetryDelay" />
<MemberSignature Language="VB.NET" Value="Public Property BaseRetryDelay As TimeSpan" />
<MemberSignature Language="F#" Value="member this.BaseRetryDelay : TimeSpan with get, set" Usage="Microsoft.ServiceFabric.Services.Communication.Client.ExponentialRetryPolicy.BaseRetryDelay" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the initial delay before retrying. All retries would be exponentially increasing from this value.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ClientRetryTimeout">
<MemberSignature Language="C#" Value="public TimeSpan ClientRetryTimeout { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan ClientRetryTimeout" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceFabric.Services.Communication.Client.ExponentialRetryPolicy.ClientRetryTimeout" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ClientRetryTimeout As TimeSpan" />
<MemberSignature Language="F#" Value="member this.ClientRetryTimeout : TimeSpan" Usage="Microsoft.ServiceFabric.Services.Communication.Client.ExponentialRetryPolicy.ClientRetryTimeout" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember>P:Microsoft.ServiceFabric.Services.Communication.Client.IRetryPolicy.ClientRetryTimeout</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="GetNextRetryDelay">
<MemberSignature Language="C#" Value="public TimeSpan GetNextRetryDelay (Microsoft.ServiceFabric.Services.Communication.Client.RetryDelayParameters retryDelayParameters);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance valuetype System.TimeSpan GetNextRetryDelay(class Microsoft.ServiceFabric.Services.Communication.Client.RetryDelayParameters retryDelayParameters) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Services.Communication.Client.ExponentialRetryPolicy.GetNextRetryDelay(Microsoft.ServiceFabric.Services.Communication.Client.RetryDelayParameters)" />
<MemberSignature Language="VB.NET" Value="Public Function GetNextRetryDelay (retryDelayParameters As RetryDelayParameters) As TimeSpan" />
<MemberSignature Language="F#" Value="abstract member GetNextRetryDelay : Microsoft.ServiceFabric.Services.Communication.Client.RetryDelayParameters -> TimeSpan
override this.GetNextRetryDelay : Microsoft.ServiceFabric.Services.Communication.Client.RetryDelayParameters -> TimeSpan" Usage="exponentialRetryPolicy.GetNextRetryDelay retryDelayParameters" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.ServiceFabric.Services.Communication.Client.IRetryPolicy.GetNextRetryDelay(Microsoft.ServiceFabric.Services.Communication.Client.RetryDelayParameters)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="retryDelayParameters" Type="Microsoft.ServiceFabric.Services.Communication.Client.RetryDelayParameters" />
</Parameters>
<Docs>
<param name="retryDelayParameters">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="MaxDelayMultiplier">
<MemberSignature Language="C#" Value="public static int MaxDelayMultiplier { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property int32 MaxDelayMultiplier" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceFabric.Services.Communication.Client.ExponentialRetryPolicy.MaxDelayMultiplier" />
<MemberSignature Language="VB.NET" Value="Public Shared Property MaxDelayMultiplier As Integer" />
<MemberSignature Language="F#" Value="static member MaxDelayMultiplier : int with get, set" Usage="Microsoft.ServiceFabric.Services.Communication.Client.ExponentialRetryPolicy.MaxDelayMultiplier" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the maximum multiplier for delay. MaxDelay equals BaseRetryDelay * (2 to the power of MaxDelayMultiplier).
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SameDelayRequestCounter">
<MemberSignature Language="C#" Value="public static int SameDelayRequestCounter { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property int32 SameDelayRequestCounter" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceFabric.Services.Communication.Client.ExponentialRetryPolicy.SameDelayRequestCounter" />
<MemberSignature Language="VB.NET" Value="Public Shared Property SameDelayRequestCounter As Integer" />
<MemberSignature Language="F#" Value="static member SameDelayRequestCounter : int with get, set" Usage="Microsoft.ServiceFabric.Services.Communication.Client.ExponentialRetryPolicy.SameDelayRequestCounter" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the number of requests to use the same delay in a row. This slows the exponential backoff.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TotalNumberOfRetries">
<MemberSignature Language="C#" Value="public int TotalNumberOfRetries { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 TotalNumberOfRetries" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceFabric.Services.Communication.Client.ExponentialRetryPolicy.TotalNumberOfRetries" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property TotalNumberOfRetries As Integer" />
<MemberSignature Language="F#" Value="member this.TotalNumberOfRetries : int" Usage="Microsoft.ServiceFabric.Services.Communication.Client.ExponentialRetryPolicy.TotalNumberOfRetries" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember>P:Microsoft.ServiceFabric.Services.Communication.Client.IRetryPolicy.TotalNumberOfRetries</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
</Type>