-
Notifications
You must be signed in to change notification settings - Fork 261
/
ProvisioningClientAmqpSettings.xml
127 lines (127 loc) · 8.07 KB
/
ProvisioningClientAmqpSettings.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
<Type Name="ProvisioningClientAmqpSettings" FullName="Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientAmqpSettings">
<TypeSignature Language="C#" Value="public sealed class ProvisioningClientAmqpSettings : Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientTransportSettings" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit ProvisioningClientAmqpSettings extends Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientTransportSettings" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientAmqpSettings" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class ProvisioningClientAmqpSettings
Inherits ProvisioningClientTransportSettings" />
<TypeSignature Language="F#" Value="type ProvisioningClientAmqpSettings = class
 inherit ProvisioningClientTransportSettings" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientTransportSettings</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Contains AMQP transport-specific settings for a provisioning device client.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ProvisioningClientAmqpSettings (Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientTransportProtocol transportProtocol = Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientTransportProtocol.Tcp);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientTransportProtocol transportProtocol) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientAmqpSettings.#ctor(Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientTransportProtocol)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (Optional transportProtocol As ProvisioningClientTransportProtocol = Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientTransportProtocol.Tcp)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientAmqpSettings : Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientTransportProtocol -> Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientAmqpSettings" Usage="new Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientAmqpSettings transportProtocol" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="transportProtocol" Type="Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientTransportProtocol" />
</Parameters>
<Docs>
<param name="transportProtocol">The transport protocol; defaults to TCP.</param>
<summary>
Creates an instance of this class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ClientWebSocket">
<MemberSignature Language="C#" Value="public System.Net.WebSockets.ClientWebSocket ClientWebSocket { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Net.WebSockets.ClientWebSocket ClientWebSocket" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientAmqpSettings.ClientWebSocket" />
<MemberSignature Language="VB.NET" Value="Public Property ClientWebSocket As ClientWebSocket" />
<MemberSignature Language="F#" Value="member this.ClientWebSocket : System.Net.WebSockets.ClientWebSocket with get, set" Usage="Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientAmqpSettings.ClientWebSocket" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Net.WebSockets.ClientWebSocket</ReturnType>
</ReturnValue>
<Docs>
<summary>
The client web socket to use when communicating over web sockets.
</summary>
<value>To be added.</value>
<remarks>
This option is ignored for TCP connections.
<para>
If not provided, a client web socket instance will be created for you based on the other
settings provided in this class. If provided, all other web socket level options set in this
class will be ignored (WebSocketKeepAlive, proxy, and x509 certificates, for example).
</para></remarks>
</Docs>
</Member>
<Member MemberName="IdleTimeout">
<MemberSignature Language="C#" Value="public TimeSpan IdleTimeout { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan IdleTimeout" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientAmqpSettings.IdleTimeout" />
<MemberSignature Language="VB.NET" Value="Public Property IdleTimeout As TimeSpan" />
<MemberSignature Language="F#" Value="member this.IdleTimeout : TimeSpan with get, set" Usage="Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientAmqpSettings.IdleTimeout" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>
Specify client-side heartbeat interval.
The interval, that the client establishes with the service, for sending keep alive pings.
</summary>
<value>To be added.</value>
<remarks>
<para>
The default value is 2 minutes.
</para>
<para>
The client will consider the connection as disconnected if the keep alive ping fails.
Setting a very low idle timeout value can cause aggressive reconnects, and might not give the
client enough time to establish a connection before disconnecting and reconnecting.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="WebSocketKeepAlive">
<MemberSignature Language="C#" Value="public TimeSpan? WebSocketKeepAlive { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.TimeSpan> WebSocketKeepAlive" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientAmqpSettings.WebSocketKeepAlive" />
<MemberSignature Language="VB.NET" Value="Public Property WebSocketKeepAlive As Nullable(Of TimeSpan)" />
<MemberSignature Language="F#" Value="member this.WebSocketKeepAlive : Nullable<TimeSpan> with get, set" Usage="Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientAmqpSettings.WebSocketKeepAlive" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.TimeSpan></ReturnType>
</ReturnValue>
<Docs>
<summary>
A keep-alive for the transport layer in sending ping/pong control frames when using web sockets.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>