-
Notifications
You must be signed in to change notification settings - Fork 256
/
ProvisioningTransportHandlerAmqp.xml
138 lines (138 loc) · 11 KB
/
ProvisioningTransportHandlerAmqp.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
<Type Name="ProvisioningTransportHandlerAmqp" FullName="Microsoft.Azure.Devices.Provisioning.Client.Transport.ProvisioningTransportHandlerAmqp">
<TypeSignature Language="C#" Value="public class ProvisioningTransportHandlerAmqp : Microsoft.Azure.Devices.Provisioning.Client.Transport.ProvisioningTransportHandler" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ProvisioningTransportHandlerAmqp extends Microsoft.Azure.Devices.Provisioning.Client.Transport.ProvisioningTransportHandler" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Devices.Provisioning.Client.Transport.ProvisioningTransportHandlerAmqp" />
<TypeSignature Language="VB.NET" Value="Public Class ProvisioningTransportHandlerAmqp
Inherits ProvisioningTransportHandler" />
<TypeSignature Language="F#" Value="type ProvisioningTransportHandlerAmqp = class
 inherit ProvisioningTransportHandler" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Transport.Amqp</AssemblyName>
<AssemblyVersion>1.13.4.0</AssemblyVersion>
<AssemblyVersion>1.13.6.0</AssemblyVersion>
<AssemblyVersion>1.13.7.0</AssemblyVersion>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.14.1.0</AssemblyVersion>
<AssemblyVersion>1.15.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.16.1.0</AssemblyVersion>
<AssemblyVersion>1.16.2.0</AssemblyVersion>
<AssemblyVersion>1.16.3.0</AssemblyVersion>
<AssemblyVersion>1.16.4.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Azure.Devices.Provisioning.Client.Transport.ProvisioningTransportHandler</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Represents the AMQP protocol implementation for the Provisioning Transport Handler.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ProvisioningTransportHandlerAmqp (Microsoft.Azure.Devices.Shared.TransportFallbackType transportFallbackType = Microsoft.Azure.Devices.Shared.TransportFallbackType.TcpWithWebSocketFallback);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Microsoft.Azure.Devices.Shared.TransportFallbackType transportFallbackType) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Client.Transport.ProvisioningTransportHandlerAmqp.#ctor(Microsoft.Azure.Devices.Shared.TransportFallbackType)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (Optional transportFallbackType As TransportFallbackType = Microsoft.Azure.Devices.Shared.TransportFallbackType.TcpWithWebSocketFallback)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Devices.Provisioning.Client.Transport.ProvisioningTransportHandlerAmqp : Microsoft.Azure.Devices.Shared.TransportFallbackType -> Microsoft.Azure.Devices.Provisioning.Client.Transport.ProvisioningTransportHandlerAmqp" Usage="new Microsoft.Azure.Devices.Provisioning.Client.Transport.ProvisioningTransportHandlerAmqp transportFallbackType" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Transport.Amqp</AssemblyName>
<AssemblyVersion>1.13.7.0</AssemblyVersion>
<AssemblyVersion>1.16.1.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="transportFallbackType" Type="Microsoft.Azure.Devices.Shared.TransportFallbackType" />
</Parameters>
<Docs>
<param name="transportFallbackType">The fallback type allowing direct or WebSocket connections.</param>
<summary>
Creates an instance of the ProvisioningTransportHandlerAmqp class using the specified fallback type.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="FallbackType">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Devices.Shared.TransportFallbackType FallbackType { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.Devices.Shared.TransportFallbackType FallbackType" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Provisioning.Client.Transport.ProvisioningTransportHandlerAmqp.FallbackType" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property FallbackType As TransportFallbackType" />
<MemberSignature Language="F#" Value="member this.FallbackType : Microsoft.Azure.Devices.Shared.TransportFallbackType" Usage="Microsoft.Azure.Devices.Provisioning.Client.Transport.ProvisioningTransportHandlerAmqp.FallbackType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Transport.Amqp</AssemblyName>
<AssemblyVersion>1.13.7.0</AssemblyVersion>
<AssemblyVersion>1.16.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Devices.Shared.TransportFallbackType</ReturnType>
</ReturnValue>
<Docs>
<summary>
The fallback type. This allows direct or WebSocket connections.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RegisterAsync">
<MemberSignature Language="C#" Value="public override System.Threading.Tasks.Task<Microsoft.Azure.Devices.Provisioning.Client.DeviceRegistrationResult> RegisterAsync (Microsoft.Azure.Devices.Provisioning.Client.Transport.ProvisioningTransportRegisterMessage message, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Azure.Devices.Provisioning.Client.DeviceRegistrationResult> RegisterAsync(class Microsoft.Azure.Devices.Provisioning.Client.Transport.ProvisioningTransportRegisterMessage message, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Client.Transport.ProvisioningTransportHandlerAmqp.RegisterAsync(Microsoft.Azure.Devices.Provisioning.Client.Transport.ProvisioningTransportRegisterMessage,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function RegisterAsync (message As ProvisioningTransportRegisterMessage, cancellationToken As CancellationToken) As Task(Of DeviceRegistrationResult)" />
<MemberSignature Language="F#" Value="override this.RegisterAsync : Microsoft.Azure.Devices.Provisioning.Client.Transport.ProvisioningTransportRegisterMessage * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.Provisioning.Client.DeviceRegistrationResult>" Usage="provisioningTransportHandlerAmqp.RegisterAsync (message, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Transport.Amqp</AssemblyName>
<AssemblyVersion>1.13.7.0</AssemblyVersion>
<AssemblyVersion>1.16.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.Devices.Provisioning.Client.DeviceRegistrationResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="Microsoft.Azure.Devices.Provisioning.Client.Transport.ProvisioningTransportRegisterMessage" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="message">The provisioning message.</param>
<param name="cancellationToken">The cancellation token.</param>
<summary>
Registers a device described by the message. Because the AMQP library does not accept cancellation tokens, the provided cancellation token
will only be checked for cancellation between AMQP operations. The timeout will be respected during the AMQP operations.
</summary>
<returns>The registration result.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RegisterAsync">
<MemberSignature Language="C#" Value="public override System.Threading.Tasks.Task<Microsoft.Azure.Devices.Provisioning.Client.DeviceRegistrationResult> RegisterAsync (Microsoft.Azure.Devices.Provisioning.Client.Transport.ProvisioningTransportRegisterMessage message, TimeSpan timeout);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Azure.Devices.Provisioning.Client.DeviceRegistrationResult> RegisterAsync(class Microsoft.Azure.Devices.Provisioning.Client.Transport.ProvisioningTransportRegisterMessage message, valuetype System.TimeSpan timeout) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Client.Transport.ProvisioningTransportHandlerAmqp.RegisterAsync(Microsoft.Azure.Devices.Provisioning.Client.Transport.ProvisioningTransportRegisterMessage,System.TimeSpan)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function RegisterAsync (message As ProvisioningTransportRegisterMessage, timeout As TimeSpan) As Task(Of DeviceRegistrationResult)" />
<MemberSignature Language="F#" Value="override this.RegisterAsync : Microsoft.Azure.Devices.Provisioning.Client.Transport.ProvisioningTransportRegisterMessage * TimeSpan -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.Provisioning.Client.DeviceRegistrationResult>" Usage="provisioningTransportHandlerAmqp.RegisterAsync (message, timeout)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Transport.Amqp</AssemblyName>
<AssemblyVersion>1.16.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.Devices.Provisioning.Client.DeviceRegistrationResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="Microsoft.Azure.Devices.Provisioning.Client.Transport.ProvisioningTransportRegisterMessage" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="timeout" Type="System.TimeSpan" Index="1" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="message">The provisioning message.</param>
<param name="timeout">The maximum amount of time to allow this operation to run for before timing out.</param>
<summary>
Registers a device described by the message.
</summary>
<returns>The registration result.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>