MqttTransportSettings Class

Definition

Namespace:

Microsoft.Azure.Devices.Client.Transport.Mqtt

Assembly:

Microsoft.Azure.Devices.Client.dll

Package:

Microsoft.Azure.Devices.Client v1.41.2

Settings for MQTT transport

public class MqttTransportSettings : Microsoft.Azure.Devices.Client.ITransportSettings

type MqttTransportSettings = class
    interface ITransportSettings

Public Class MqttTransportSettings
Implements ITransportSettings

Inheritance

Object

MqttTransportSettings

Implements

ITransportSettings

Constructors

MqttTransportSettings(TransportType)

Creates an instance based on the specified type options

Properties

CertificateRevocationCheck	Indicates if certificate revocation check is enabled. The default value is false.
CleanSession	Flag to specify if a subscription should persist across different sessions. The default value is false.
ClientCertificate	The client certificate to be used for authenticating the TLS connection.
ConnectArrivalTimeout	The time to wait for receiving an acknowledgment for a CONNECT packet. The default is 60 seconds.
DefaultReceiveTimeout	The time to wait for a receive operation. The default value is 1 minute.
DeviceReceiveAckCanTimeout	Indicates if a device can timeout while waiting for a acknowledgment from service. The default value is false.
DeviceReceiveAckTimeout	The time a device will wait for an acknowledgment from service. The default is 5 minutes.
DupPropertyName	The property on a message that indicates the publish packet is marked as a duplicate.
HasWill	Indicates whether the transport has a will message.
KeepAliveInSeconds	The interval, in seconds, that the client establishes with the service, for sending protocol-level keep-alive pings. The default is 300 seconds.
MaxOutboundRetransmissionEnforced	Indicates if max outbound retransmission is enforced. The default value is false.
MaxPendingInboundMessages	The maximum no. of inbound messages that are read from the channel. The default value is 50.
Proxy	The proxy settings to be used when communicating with IoT Hub.
PublishToServerQoS	The QoS to be used when sending packets to service. The default value is DotNetty.Codecs.Mqtt.Packets.QualityOfService.AtLeastOnce.
QoSPropertyName	The property name setting the QoS for a packet.
ReceivingQoS	The QoS to be used when subscribing to receive packets from the service. The default value is DotNetty.Codecs.Mqtt.Packets.QualityOfService.AtLeastOnce.
RemoteCertificateValidationCallback	A callback for remote certificate validation. If incorrectly implemented, your device may fail to connect to IoTHub and/or be open to security vulnerabilities.
RetainPropertyName	The property on a message that indicates the publish packet has requested to be retained.
WebSocketKeepAlive	A keep-alive for the transport layer in sending ping/pong control frames when using web sockets.
WillMessage	The configured will message that is sent to the telemetry channel on an ungraceful disconnect.

Methods

GetTransportType()

The connection transport type.