Class MqttWill

Namespace

Pamoja.Mqtt

Assembly

Pamoja.Mqtt.dll

A message the broker publishes on the client's behalf if its connection ends without a disconnect: the network dropped, the power failed, or the keep-alive ran out.

public sealed record MqttWill : IEquatable<MqttWill>

Inheritance

object

MqttWill

Implements

IEquatable<MqttWill>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

A client that calls DisconnectAsync() leaves no will behind.

Constructors

MqttWill(string, ReadOnlyMemory<byte>)

A message the broker publishes on the client's behalf if its connection ends without a disconnect: the network dropped, the power failed, or the keep-alive ran out.

public MqttWill(string Topic, ReadOnlyMemory<byte> Payload)

Parameters

Topic string

The topic the broker publishes it to, with no wildcard.

Payload ReadOnlyMemory<byte>

What it publishes.

Remarks

A client that calls DisconnectAsync() leaves no will behind.

MqttWill(string, string)

Creates a will whose payload is text, encoded as UTF-8.

public MqttWill(string topic, string payload)

Parameters

topic string

The topic the broker publishes it to.

payload string

What it publishes.

Properties

Payload

What it publishes.

public ReadOnlyMemory<byte> Payload { get; init; }

Property Value

ReadOnlyMemory<byte>

Qos

The quality of service it is published at.

public Qos Qos { get; init; }

Property Value

Qos

Retain

Whether the broker retains it for clients that subscribe later.

public bool Retain { get; init; }

Property Value

bool

Topic

The topic the broker publishes it to, with no wildcard.

public string Topic { get; init; }

Property Value

string