-
Notifications
You must be signed in to change notification settings - Fork 255
/
RecommendedAction.xml
118 lines (118 loc) · 6.84 KB
/
RecommendedAction.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
<Type Name="RecommendedAction" FullName="Microsoft.Azure.Devices.Client.RecommendedAction">
<TypeSignature Language="C#" Value="public enum RecommendedAction" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed RecommendedAction extends System.Enum" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Devices.Client.RecommendedAction" />
<TypeSignature Language="VB.NET" Value="Public Enum RecommendedAction" />
<TypeSignature Language="F#" Value="type RecommendedAction = " />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>
The recommended action for device applications to take in response to a connection change event.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="OpenConnection">
<MemberSignature Language="C#" Value="OpenConnection" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Microsoft.Azure.Devices.Client.RecommendedAction OpenConnection = int32(0)" />
<MemberSignature Language="DocId" Value="F:Microsoft.Azure.Devices.Client.RecommendedAction.OpenConnection" />
<MemberSignature Language="VB.NET" Value="OpenConnection" />
<MemberSignature Language="F#" Value="OpenConnection = 0" Usage="Microsoft.Azure.Devices.Client.RecommendedAction.OpenConnection" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Devices.Client.RecommendedAction</ReturnType>
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>
It's recommended to initialize (if previously open, dispose, and then call open) the device client when the client is not connected.
</summary>
<remarks>
When a client is first initialized, this is the default state.
When a client is disconnected with retries being exhausted or non-retryable errors, the client also returns the decision on whether to attempt reconnection to
the device app, with reasons such as:
<list type="bullet"><item><see cref="F:Microsoft.Azure.Devices.Client.ConnectionStatusChangeReason.RetryExpired" /></item><item><see cref="F:Microsoft.Azure.Devices.Client.ConnectionStatusChangeReason.CommunicationError" /></item></list></remarks>
</Docs>
</Member>
<Member MemberName="PerformNormally">
<MemberSignature Language="C#" Value="PerformNormally" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Microsoft.Azure.Devices.Client.RecommendedAction PerformNormally = int32(1)" />
<MemberSignature Language="DocId" Value="F:Microsoft.Azure.Devices.Client.RecommendedAction.PerformNormally" />
<MemberSignature Language="VB.NET" Value="PerformNormally" />
<MemberSignature Language="F#" Value="PerformNormally = 1" Usage="Microsoft.Azure.Devices.Client.RecommendedAction.PerformNormally" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Devices.Client.RecommendedAction</ReturnType>
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>
It's recommended to perform operations normally on your device client as it is successfully connected to the IoT hub.
</summary>
</Docs>
</Member>
<Member MemberName="Quit">
<MemberSignature Language="C#" Value="Quit" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Microsoft.Azure.Devices.Client.RecommendedAction Quit = int32(3)" />
<MemberSignature Language="DocId" Value="F:Microsoft.Azure.Devices.Client.RecommendedAction.Quit" />
<MemberSignature Language="VB.NET" Value="Quit" />
<MemberSignature Language="F#" Value="Quit = 3" Usage="Microsoft.Azure.Devices.Client.RecommendedAction.Quit" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Devices.Client.RecommendedAction</ReturnType>
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary>
This is a terminal state of the client where it is unclear if the device will ever be able to connect, and may require manual intervention.
</summary>
<remarks>
This can occur when the client has been closed gracefully (by calling <see cref="M:Microsoft.Azure.Devices.Client.IotHubBaseClient.CloseAsync(System.Threading.CancellationToken)" />.
Other terminal states include when the client has been disconnected due to non-retryable exceptions. The disconnection reasons include:
<list type="bullet"><item><see cref="F:Microsoft.Azure.Devices.Client.ConnectionStatusChangeReason.BadCredential" /></item><item><see cref="F:Microsoft.Azure.Devices.Client.ConnectionStatusChangeReason.DeviceDisabled" /></item></list></remarks>
</Docs>
</Member>
<Member MemberName="WaitForRetryPolicy">
<MemberSignature Language="C#" Value="WaitForRetryPolicy" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Microsoft.Azure.Devices.Client.RecommendedAction WaitForRetryPolicy = int32(2)" />
<MemberSignature Language="DocId" Value="F:Microsoft.Azure.Devices.Client.RecommendedAction.WaitForRetryPolicy" />
<MemberSignature Language="VB.NET" Value="WaitForRetryPolicy" />
<MemberSignature Language="F#" Value="WaitForRetryPolicy = 2" Usage="Microsoft.Azure.Devices.Client.RecommendedAction.WaitForRetryPolicy" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Devices.Client.RecommendedAction</ReturnType>
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>
It's recommended to not perform any operations on the client while it is trying to reconnect.
</summary>
<remarks>
This occurs when the client has encountered a retryable error. The connection status is <see cref="F:Microsoft.Azure.Devices.Client.ConnectionStatus.DisconnectedRetrying" />.
</remarks>
</Docs>
</Member>
</Members>
</Type>