-
Notifications
You must be signed in to change notification settings - Fork 255
/
MqttTransportSettings.xml
601 lines (601 loc) · 34.3 KB
/
MqttTransportSettings.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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
<Type Name="MqttTransportSettings" FullName="Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings">
<TypeSignature Language="C#" Value="public class MqttTransportSettings : Microsoft.Azure.Devices.Client.ITransportSettings" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit MqttTransportSettings extends System.Object implements class Microsoft.Azure.Devices.Client.ITransportSettings" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings" />
<TypeSignature Language="VB.NET" Value="Public Class MqttTransportSettings
Implements ITransportSettings" />
<TypeSignature Language="F#" Value="type MqttTransportSettings = class
 interface ITransportSettings" />
<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>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.Azure.Devices.Client.ITransportSettings</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
Settings for MQTT transport
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public MqttTransportSettings (Microsoft.Azure.Devices.Client.TransportType transportType);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Microsoft.Azure.Devices.Client.TransportType transportType) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.#ctor(Microsoft.Azure.Devices.Client.TransportType)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (transportType As TransportType)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings : Microsoft.Azure.Devices.Client.TransportType -> Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings" Usage="new Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings transportType" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>1.36.6.0</AssemblyVersion>
<AssemblyVersion>1.41.2.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="transportType" Type="Microsoft.Azure.Devices.Client.TransportType" />
</Parameters>
<Docs>
<param name="transportType">The transport type, of Mqtt_WebSocket_Only, or Mqtt_Tcp_Only</param>
<summary>
Creates an instance based on the specified type options
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CertificateRevocationCheck">
<MemberSignature Language="C#" Value="public bool CertificateRevocationCheck { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool CertificateRevocationCheck" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.CertificateRevocationCheck" />
<MemberSignature Language="VB.NET" Value="Public Property CertificateRevocationCheck As Boolean" />
<MemberSignature Language="F#" Value="member this.CertificateRevocationCheck : bool with get, set" Usage="Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.CertificateRevocationCheck" />
<MemberType>Property</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>
<Docs>
<summary>
Indicates if certificate revocation check is enabled. The default value is <c>false</c>.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CleanSession">
<MemberSignature Language="C#" Value="public bool CleanSession { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool CleanSession" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.CleanSession" />
<MemberSignature Language="VB.NET" Value="Public Property CleanSession As Boolean" />
<MemberSignature Language="F#" Value="member this.CleanSession : bool with get, set" Usage="Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.CleanSession" />
<MemberType>Property</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>
<Docs>
<summary>
Flag to specify if a subscription should persist across different sessions. The default value is false.
</summary>
<value>To be added.</value>
<remarks>
<para>If set to false: the device will receive messages that were sent to it while it was disconnected.</para>
<para>If set to true: the device will receive only those messages that were sent to it
after it successfully subscribed to the device bound message topic.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="ClientCertificate">
<MemberSignature Language="C#" Value="public System.Security.Cryptography.X509Certificates.X509Certificate ClientCertificate { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Security.Cryptography.X509Certificates.X509Certificate ClientCertificate" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.ClientCertificate" />
<MemberSignature Language="VB.NET" Value="Public Property ClientCertificate As X509Certificate" />
<MemberSignature Language="F#" Value="member this.ClientCertificate : System.Security.Cryptography.X509Certificates.X509Certificate with get, set" Usage="Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.ClientCertificate" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>1.36.6.0</AssemblyVersion>
<AssemblyVersion>1.41.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Security.Cryptography.X509Certificates.X509Certificate</ReturnType>
</ReturnValue>
<Docs>
<summary>
The client certificate to be used for authenticating the TLS connection.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ConnectArrivalTimeout">
<MemberSignature Language="C#" Value="public TimeSpan ConnectArrivalTimeout { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan ConnectArrivalTimeout" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.ConnectArrivalTimeout" />
<MemberSignature Language="VB.NET" Value="Public Property ConnectArrivalTimeout As TimeSpan" />
<MemberSignature Language="F#" Value="member this.ConnectArrivalTimeout : TimeSpan with get, set" Usage="Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.ConnectArrivalTimeout" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>1.36.6.0</AssemblyVersion>
<AssemblyVersion>1.41.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>
The time to wait for receiving an acknowledgment for a CONNECT packet.
The default is 60 seconds.
</summary>
<value>To be added.</value>
<remarks>
In the event that IoT hub receives burst traffic, it will implement traffic shaping in order to process the incoming requests.
In such cases, during client connection the CONNECT requests can have a delay in being acknowledged and processed by IoT hub.
The <c>ConnectArrivalTimeout</c> governs the duration the client will wait for a CONNACK packet before disconnecting and reopening the connection.
To know more about IoT hub's throttling limits and traffic shaping feature, see
<see href="https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-quotas-throttling#operation-throttles" />.
</remarks>
</Docs>
</Member>
<Member MemberName="DefaultReceiveTimeout">
<MemberSignature Language="C#" Value="public TimeSpan DefaultReceiveTimeout { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan DefaultReceiveTimeout" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.DefaultReceiveTimeout" />
<MemberSignature Language="VB.NET" Value="Public Property DefaultReceiveTimeout As TimeSpan" />
<MemberSignature Language="F#" Value="member this.DefaultReceiveTimeout : TimeSpan with get, set" Usage="Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.DefaultReceiveTimeout" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>1.36.6.0</AssemblyVersion>
<AssemblyVersion>1.41.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>
The time to wait for a receive operation. The default value is 1 minute.
</summary>
<value>To be added.</value>
<remarks>
This property is currently unused.
</remarks>
</Docs>
</Member>
<Member MemberName="DeviceReceiveAckCanTimeout">
<MemberSignature Language="C#" Value="public bool DeviceReceiveAckCanTimeout { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool DeviceReceiveAckCanTimeout" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.DeviceReceiveAckCanTimeout" />
<MemberSignature Language="VB.NET" Value="Public Property DeviceReceiveAckCanTimeout As Boolean" />
<MemberSignature Language="F#" Value="member this.DeviceReceiveAckCanTimeout : bool with get, set" Usage="Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.DeviceReceiveAckCanTimeout" />
<MemberType>Property</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>
<Docs>
<summary>
Indicates if a device can timeout while waiting for a acknowledgment from service.
The default value is <c>false</c>.
</summary>
<value>To be added.</value>
<remarks>
This property is currently unused.
</remarks>
</Docs>
</Member>
<Member MemberName="DeviceReceiveAckTimeout">
<MemberSignature Language="C#" Value="public TimeSpan DeviceReceiveAckTimeout { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan DeviceReceiveAckTimeout" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.DeviceReceiveAckTimeout" />
<MemberSignature Language="VB.NET" Value="Public Property DeviceReceiveAckTimeout As TimeSpan" />
<MemberSignature Language="F#" Value="member this.DeviceReceiveAckTimeout : TimeSpan with get, set" Usage="Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.DeviceReceiveAckTimeout" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>1.36.6.0</AssemblyVersion>
<AssemblyVersion>1.41.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>
The time a device will wait for an acknowledgment from service.
The default is 5 minutes.
</summary>
<value>To be added.</value>
<remarks>
This property is currently unused.
</remarks>
</Docs>
</Member>
<Member MemberName="DupPropertyName">
<MemberSignature Language="C#" Value="public string DupPropertyName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string DupPropertyName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.DupPropertyName" />
<MemberSignature Language="VB.NET" Value="Public Property DupPropertyName As String" />
<MemberSignature Language="F#" Value="member this.DupPropertyName : string with get, set" Usage="Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.DupPropertyName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>1.36.6.0</AssemblyVersion>
<AssemblyVersion>1.41.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The property on a message that indicates the publish packet is marked as a duplicate.
</summary>
<value>To be added.</value>
<remarks>
This property is currently unused.
</remarks>
</Docs>
</Member>
<Member MemberName="GetTransportType">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Devices.Client.TransportType GetTransportType ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance valuetype Microsoft.Azure.Devices.Client.TransportType GetTransportType() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.GetTransportType" />
<MemberSignature Language="VB.NET" Value="Public Function GetTransportType () As TransportType" />
<MemberSignature Language="F#" Value="abstract member GetTransportType : unit -> Microsoft.Azure.Devices.Client.TransportType
override this.GetTransportType : unit -> Microsoft.Azure.Devices.Client.TransportType" Usage="mqttTransportSettings.GetTransportType " />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Azure.Devices.Client.ITransportSettings.GetTransportType</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>1.36.6.0</AssemblyVersion>
<AssemblyVersion>1.41.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Devices.Client.TransportType</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
The connection transport type.
</summary>
<returns />
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HasWill">
<MemberSignature Language="C#" Value="public bool HasWill { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool HasWill" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.HasWill" />
<MemberSignature Language="VB.NET" Value="Public Property HasWill As Boolean" />
<MemberSignature Language="F#" Value="member this.HasWill : bool with get, set" Usage="Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.HasWill" />
<MemberType>Property</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>
<Docs>
<summary>
Indicates whether the transport has a will message.
</summary>
<value>To be added.</value>
<remarks>
Setting a will message is a way for clients to notify other subscribed clients about ungraceful disconnects in an appropriate way.
In response to the ungraceful disconnect, the service will send the last-will message to the configured telemetry channel.
The telemetry channel can be either the default Events endpoint or a custom endpoint defined by IoT hub routing.
For more details, refer to https://docs.microsoft.com/azure/iot-hub/iot-hub-mqtt-support#using-the-mqtt-protocol-directly-as-a-device.
</remarks>
</Docs>
</Member>
<Member MemberName="KeepAliveInSeconds">
<MemberSignature Language="C#" Value="public int KeepAliveInSeconds { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 KeepAliveInSeconds" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.KeepAliveInSeconds" />
<MemberSignature Language="VB.NET" Value="Public Property KeepAliveInSeconds As Integer" />
<MemberSignature Language="F#" Value="member this.KeepAliveInSeconds : int with get, set" Usage="Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.KeepAliveInSeconds" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>1.36.6.0</AssemblyVersion>
<AssemblyVersion>1.41.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
The interval, in seconds, that the client establishes with the service, for sending protocol-level keep-alive pings.
The default is 300 seconds.
</summary>
<value>To be added.</value>
<remarks>
The client will send a ping request 4 times per keep-alive duration set.
It will wait for 30 seconds for the ping response, else mark the connection as disconnected.
Setting a very low keep-alive value can cause aggressive reconnects, and might not give the
client enough time to establish a connection before disconnecting and reconnecting.
</remarks>
</Docs>
</Member>
<Member MemberName="MaxOutboundRetransmissionEnforced">
<MemberSignature Language="C#" Value="public bool MaxOutboundRetransmissionEnforced { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool MaxOutboundRetransmissionEnforced" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.MaxOutboundRetransmissionEnforced" />
<MemberSignature Language="VB.NET" Value="Public Property MaxOutboundRetransmissionEnforced As Boolean" />
<MemberSignature Language="F#" Value="member this.MaxOutboundRetransmissionEnforced : bool with get, set" Usage="Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.MaxOutboundRetransmissionEnforced" />
<MemberType>Property</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>
<Docs>
<summary>
Indicates if max outbound retransmission is enforced.
The default value is <c>false</c>.
</summary>
<value>To be added.</value>
<remarks>
This property is currently unused.
</remarks>
</Docs>
</Member>
<Member MemberName="MaxPendingInboundMessages">
<MemberSignature Language="C#" Value="public int MaxPendingInboundMessages { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 MaxPendingInboundMessages" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.MaxPendingInboundMessages" />
<MemberSignature Language="VB.NET" Value="Public Property MaxPendingInboundMessages As Integer" />
<MemberSignature Language="F#" Value="member this.MaxPendingInboundMessages : int with get, set" Usage="Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.MaxPendingInboundMessages" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>1.36.6.0</AssemblyVersion>
<AssemblyVersion>1.41.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
The maximum no. of inbound messages that are read from the channel.
The default value is 50.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Proxy">
<MemberSignature Language="C#" Value="public System.Net.IWebProxy Proxy { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Net.IWebProxy Proxy" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.Proxy" />
<MemberSignature Language="VB.NET" Value="Public Property Proxy As IWebProxy" />
<MemberSignature Language="F#" Value="member this.Proxy : System.Net.IWebProxy with get, set" Usage="Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.Proxy" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember FrameworkAlternate="azure-dotnet">P:Microsoft.Azure.Devices.Client.ITransportSettings.Proxy</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>1.36.6.0</AssemblyVersion>
<AssemblyVersion>1.41.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Net.IWebProxy</ReturnType>
</ReturnValue>
<Docs>
<summary>
The proxy settings to be used when communicating with IoT Hub.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="PublishToServerQoS">
<MemberSignature Language="C#" Value="public DotNetty.Codecs.Mqtt.Packets.QualityOfService PublishToServerQoS { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype DotNetty.Codecs.Mqtt.Packets.QualityOfService PublishToServerQoS" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.PublishToServerQoS" />
<MemberSignature Language="VB.NET" Value="Public Property PublishToServerQoS As QualityOfService" />
<MemberSignature Language="F#" Value="member this.PublishToServerQoS : DotNetty.Codecs.Mqtt.Packets.QualityOfService with get, set" Usage="Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.PublishToServerQoS" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>1.36.6.0</AssemblyVersion>
<AssemblyVersion>1.41.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>DotNetty.Codecs.Mqtt.Packets.QualityOfService</ReturnType>
</ReturnValue>
<Docs>
<summary>
The QoS to be used when sending packets to service.
The default value is <see cref="F:DotNetty.Codecs.Mqtt.Packets.QualityOfService.AtLeastOnce" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="QoSPropertyName">
<MemberSignature Language="C#" Value="public string QoSPropertyName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string QoSPropertyName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.QoSPropertyName" />
<MemberSignature Language="VB.NET" Value="Public Property QoSPropertyName As String" />
<MemberSignature Language="F#" Value="member this.QoSPropertyName : string with get, set" Usage="Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.QoSPropertyName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>1.36.6.0</AssemblyVersion>
<AssemblyVersion>1.41.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The property name setting the QoS for a packet.
</summary>
<value>To be added.</value>
<remarks>
This property is currently unused.
</remarks>
</Docs>
</Member>
<Member MemberName="ReceivingQoS">
<MemberSignature Language="C#" Value="public DotNetty.Codecs.Mqtt.Packets.QualityOfService ReceivingQoS { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype DotNetty.Codecs.Mqtt.Packets.QualityOfService ReceivingQoS" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.ReceivingQoS" />
<MemberSignature Language="VB.NET" Value="Public Property ReceivingQoS As QualityOfService" />
<MemberSignature Language="F#" Value="member this.ReceivingQoS : DotNetty.Codecs.Mqtt.Packets.QualityOfService with get, set" Usage="Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.ReceivingQoS" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>1.36.6.0</AssemblyVersion>
<AssemblyVersion>1.41.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>DotNetty.Codecs.Mqtt.Packets.QualityOfService</ReturnType>
</ReturnValue>
<Docs>
<summary>
The QoS to be used when subscribing to receive packets from the service.
The default value is <see cref="F:DotNetty.Codecs.Mqtt.Packets.QualityOfService.AtLeastOnce" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RemoteCertificateValidationCallback">
<MemberSignature Language="C#" Value="public System.Net.Security.RemoteCertificateValidationCallback RemoteCertificateValidationCallback { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Net.Security.RemoteCertificateValidationCallback RemoteCertificateValidationCallback" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.RemoteCertificateValidationCallback" />
<MemberSignature Language="VB.NET" Value="Public Property RemoteCertificateValidationCallback As RemoteCertificateValidationCallback" />
<MemberSignature Language="F#" Value="member this.RemoteCertificateValidationCallback : System.Net.Security.RemoteCertificateValidationCallback with get, set" Usage="Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.RemoteCertificateValidationCallback" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>1.36.6.0</AssemblyVersion>
<AssemblyVersion>1.41.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Net.Security.RemoteCertificateValidationCallback</ReturnType>
</ReturnValue>
<Docs>
<summary>
A callback for remote certificate validation.
If incorrectly implemented, your device may fail to connect to IoTHub and/or be open to security vulnerabilities.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RetainPropertyName">
<MemberSignature Language="C#" Value="public string RetainPropertyName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string RetainPropertyName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.RetainPropertyName" />
<MemberSignature Language="VB.NET" Value="Public Property RetainPropertyName As String" />
<MemberSignature Language="F#" Value="member this.RetainPropertyName : string with get, set" Usage="Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.RetainPropertyName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>1.36.6.0</AssemblyVersion>
<AssemblyVersion>1.41.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The property on a message that indicates the publish packet has requested to be retained.
</summary>
<value>To be added.</value>
<remarks>
This property is currently unused.
</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.Client.Transport.Mqtt.MqttTransportSettings.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.Client.Transport.Mqtt.MqttTransportSettings.WebSocketKeepAlive" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>1.41.2.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>
This value is different from the protocol-level keep-alive packets that are sent over the overlaying MQTT transport protocol.
</remarks>
</Docs>
</Member>
<Member MemberName="WillMessage">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Devices.Client.Transport.Mqtt.IWillMessage WillMessage { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Devices.Client.Transport.Mqtt.IWillMessage WillMessage" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.WillMessage" />
<MemberSignature Language="VB.NET" Value="Public Property WillMessage As IWillMessage" />
<MemberSignature Language="F#" Value="member this.WillMessage : Microsoft.Azure.Devices.Client.Transport.Mqtt.IWillMessage with get, set" Usage="Microsoft.Azure.Devices.Client.Transport.Mqtt.MqttTransportSettings.WillMessage" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>1.36.6.0</AssemblyVersion>
<AssemblyVersion>1.41.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Devices.Client.Transport.Mqtt.IWillMessage</ReturnType>
</ReturnValue>
<Docs>
<summary>
The configured will message that is sent to the telemetry channel on an ungraceful disconnect.
</summary>
<value>To be added.</value>
<remarks>
The telemetry channel can be either the default Events endpoint or a custom endpoint defined by IoT hub routing.
For more details, refer to https://docs.microsoft.com/azure/iot-hub/iot-hub-mqtt-support#using-the-mqtt-protocol-directly-as-a-device.
</remarks>
</Docs>
</Member>
</Members>
</Type>