Class MqttClientSubscribeOptions

Namespace

Azure.Iot.Operations.Protocol.Models

Assembly

Azure.Iot.Operations.Protocol.dll

public class MqttClientSubscribeOptions

Inheritance

object

MqttClientSubscribeOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

MqttClientSubscribeOptions()

public MqttClientSubscribeOptions()

MqttClientSubscribeOptions(MqttTopicFilter)

public MqttClientSubscribeOptions(MqttTopicFilter mqttTopicFilter)

Parameters

mqttTopicFilter MqttTopicFilter

MqttClientSubscribeOptions(string, MqttQualityOfServiceLevel)

public MqttClientSubscribeOptions(string topic, MqttQualityOfServiceLevel qos = MqttQualityOfServiceLevel.AtLeastOnce)

Parameters

topic string

qos MqttQualityOfServiceLevel

Properties

SubscriptionIdentifier

Gets or sets the subscription identifier. The client can specify a subscription identifier when subscribing. The broker will establish and store the mapping relationship between this subscription and subscription identifier when successfully create or modify subscription. The broker will return the subscription identifier associated with this PUBLISH packet and the PUBLISH packet to the client when need to forward PUBLISH packets matching this subscription to this client. MQTT 5.0.0+ feature.

public uint SubscriptionIdentifier { get; set; }

Property Value

uint

TopicFilters

Gets or sets a list of topic filters the client wants to subscribe to. Topic filters can include regular topics or wild cards.

public List<MqttTopicFilter> TopicFilters { get; set; }

Property Value

List<MqttTopicFilter>

UserProperties

Gets or sets the user properties. In MQTT 5, user properties are basic UTF-8 string key-value pairs that you can append to almost every type of MQTT packet. As long as you don’t exceed the maximum message size, you can use an unlimited number of user properties to add metadata to MQTT messages and pass information between publisher, broker, and subscriber. The feature is very similar to the HTTP header concept. MQTT 5.0.0+ feature.

public List<MqttUserProperty>? UserProperties { get; set; }

Property Value

List<MqttUserProperty>

Methods

AddUserProperty(string, string)

public void AddUserProperty(string key, string value)

Parameters

key string

value string