Class MqttTopicFilter

Namespace

MQTTnet.Packets

Assembly

MQTTnet.dll

public sealed class MqttTopicFilter

Inheritance

object

MqttTopicFilter

Inherited Members

object.GetType()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

MqttTopicFilter()

public MqttTopicFilter()

Properties

NoLocal

Gets or sets a value indicating whether the sender will not receive its own published application messages. MQTT 5.0.0+ feature.

public bool NoLocal { get; set; }

Property Value

bool

QualityOfServiceLevel

Gets or sets the quality of service level. The Quality of Service (QoS) level is an agreement between the sender of a message and the receiver of a message that defines the guarantee of delivery for a specific message. There are 3 QoS levels in MQTT:

• At most once (0): Message gets delivered no time, once or multiple times.
• At least once (1): Message gets delivered at least once (one time or more often).
• Exactly once (2): Message gets delivered exactly once (It's ensured that the message only comes once).

public MqttQualityOfServiceLevel QualityOfServiceLevel { get; set; }

Property Value

MqttQualityOfServiceLevel

RetainAsPublished

Gets or sets a value indicating whether messages are retained as published or not. MQTT 5.0.0+ feature.

public bool RetainAsPublished { get; set; }

Property Value

bool

RetainHandling

Gets or sets the retain handling. MQTT 5.0.0+ feature.

public MqttRetainHandling RetainHandling { get; set; }

Property Value

MqttRetainHandling

Topic

Gets or sets the MQTT topic. In MQTT, the word topic refers to an UTF-8 string that the broker uses to filter messages for each connected client. The topic consists of one or more topic levels. Each topic level is separated by a forward slash (topic level separator).

public string Topic { get; set; }

Property Value

string

Methods

ToString()

public override string ToString()

Returns

string