-
Notifications
You must be signed in to change notification settings - Fork 256
/
IRetryPolicy.xml
64 lines (64 loc) · 3.5 KB
/
IRetryPolicy.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
<Type Name="IRetryPolicy" FullName="Microsoft.Azure.Devices.Client.IRetryPolicy">
<TypeSignature Language="C#" Value="public interface IRetryPolicy" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IRetryPolicy" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Devices.Client.IRetryPolicy" />
<TypeSignature Language="VB.NET" Value="Public Interface IRetryPolicy" />
<TypeSignature Language="F#" Value="type IRetryPolicy = interface" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>1.31.2.0</AssemblyVersion>
<AssemblyVersion>1.32.0.0</AssemblyVersion>
<AssemblyVersion>1.36.0.0</AssemblyVersion>
<AssemblyVersion>1.36.1.0</AssemblyVersion>
<AssemblyVersion>1.36.6.0</AssemblyVersion>
<AssemblyVersion>1.37.0.0</AssemblyVersion>
<AssemblyVersion>1.37.1.0</AssemblyVersion>
<AssemblyVersion>1.37.2.0</AssemblyVersion>
<AssemblyVersion>1.38.0.0</AssemblyVersion>
<AssemblyVersion>1.39.0.0</AssemblyVersion>
<AssemblyVersion>1.40.0.0</AssemblyVersion>
<AssemblyVersion>1.41.0.0</AssemblyVersion>
<AssemblyVersion>1.41.1.0</AssemblyVersion>
<AssemblyVersion>1.41.2.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<summary>
Represents a retry policy
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="ShouldRetry">
<MemberSignature Language="C#" Value="public bool ShouldRetry (int currentRetryCount, Exception lastException, out TimeSpan retryInterval);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool ShouldRetry(int32 currentRetryCount, class System.Exception lastException, [out] valuetype System.TimeSpan& retryInterval) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Client.IRetryPolicy.ShouldRetry(System.Int32,System.Exception,System.TimeSpan@)" />
<MemberSignature Language="VB.NET" Value="Public Function ShouldRetry (currentRetryCount As Integer, lastException As Exception, ByRef retryInterval As TimeSpan) As Boolean" />
<MemberSignature Language="F#" Value="abstract member ShouldRetry : int * Exception * TimeSpan -> bool" Usage="iRetryPolicy.ShouldRetry (currentRetryCount, lastException, retryInterval)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>1.36.6.0</AssemblyVersion>
<AssemblyVersion>1.41.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="currentRetryCount" Type="System.Int32" />
<Parameter Name="lastException" Type="System.Exception" />
<Parameter Name="retryInterval" Type="System.TimeSpan" RefType="out" />
</Parameters>
<Docs>
<param name="currentRetryCount">The number of times the current operation has been attempted.</param>
<param name="lastException">The exception that caused this retry policy check.</param>
<param name="retryInterval">Set this to the desired delay prior to the next attempt.</param>
<summary>
Method called by DeviceClient prior to a retry.
</summary>
<returns>True if the operation should be retried. False otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>