Class InterceptingUnsubscriptionEventArgs

Namespace

MQTTnet.Server

Assembly

MQTTnet.dll

public sealed class InterceptingUnsubscriptionEventArgs : EventArgs

Inheritance

object

EventArgs

InterceptingUnsubscriptionEventArgs

Inherited Members

EventArgs.Empty

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

InterceptingUnsubscriptionEventArgs(CancellationToken, string, IDictionary, string, List<MqttUserProperty>)

public InterceptingUnsubscriptionEventArgs(CancellationToken cancellationToken, string clientId, IDictionary sessionItems, string topic, List<MqttUserProperty> userProperties)

Parameters

cancellationToken CancellationToken

clientId string

sessionItems IDictionary

topic string

userProperties List<MqttUserProperty>

Properties

CancellationToken

Gets the cancellation token which can indicate that the client connection gets down.

public CancellationToken CancellationToken { get; }

Property Value

CancellationToken

ClientId

Gets the client identifier. Hint: This identifier needs to be unique over all used clients / devices on the broker to avoid connection issues.

public string ClientId { get; }

Property Value

string

CloseConnection

Gets or sets whether the broker should close the client connection.

public bool CloseConnection { get; set; }

Property Value

bool

ProcessUnsubscription

Gets or sets whether the broker should remove an internal subscription for the client. The broker can also avoid this and return "success" to the client. This feature allows using the MQTT Broker as the Frontend and another system as the backend.

public bool ProcessUnsubscription { get; set; }

Property Value

bool

Response

Gets the response which will be sent to the client via the UNSUBACK pocket.

public UnsubscribeResponse Response { get; }

Property Value

UnsubscribeResponse

SessionItems

Gets or sets a key/value collection that can be used to share data within the scope of this session.

public IDictionary SessionItems { get; }

Property Value

IDictionary

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; }

Property Value

string

UserProperties

Gets or sets the user properties. MQTT 5.0.0+ feature.

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

Property Value

List<MqttUserProperty>