Share via

MqttTransportSettings.CleanSession Property

  • Reference

Definition

Namespace:
Microsoft.Azure.Devices.Client.Transport.Mqtt
Assembly:
Microsoft.Azure.Devices.Client.dll
Package:
Microsoft.Azure.Devices.Client v1.41.2
Package:
Microsoft.Azure.Devices.Client v1.36.6

Flag to specify if a subscription should persist across different sessions. The default value is false.

public bool CleanSession { get; set; }
member this.CleanSession : bool with get, set
Public Property CleanSession As Boolean

Property Value

Boolean

Remarks

If set to false: the device will receive messages that were sent to it while it was disconnected.

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.

Applies to