Class InterceptingSubscriptionEventArgs

Namespace

MQTTnet.Server

Assembly

MQTTnet.dll

public sealed class InterceptingSubscriptionEventArgs : EventArgs

Inheritance

object

EventArgs

InterceptingSubscriptionEventArgs

Inherited Members

EventArgs.Empty

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

InterceptingSubscriptionEventArgs(CancellationToken, string, MqttSessionStatus, MqttTopicFilter, List<MqttUserProperty>)

public InterceptingSubscriptionEventArgs(CancellationToken cancellationToken, string clientId, MqttSessionStatus session, MqttTopicFilter topicFilter, List<MqttUserProperty> userProperties)

Parameters

cancellationToken CancellationToken

clientId string

session MqttSessionStatus

topicFilter MqttTopicFilter

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

ProcessSubscription

Gets or sets whether the broker should create 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 ProcessSubscription { get; set; }

Property Value

bool

ReasonString

Gets or sets the reason string which will be sent to the client in the SUBACK packet.

public string ReasonString { get; set; }

Property Value

string

Response

Gets the response which will be sent to the client via the SUBACK packet.

public SubscribeResponse Response { get; }

Property Value

SubscribeResponse

Session

Gets the current client session.

public MqttSessionStatus Session { get; }

Property Value

MqttSessionStatus

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

TopicFilter

Gets or sets the topic filter. The topic filter can contain topics and wildcards.

public MqttTopicFilter TopicFilter { get; set; }

Property Value

MqttTopicFilter

UserProperties

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

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

Property Value

List<MqttUserProperty>