Class MqttClientExtensions

Namespace

MQTTnet.Client

Assembly

MQTTnet.dll

public static class MqttClientExtensions

Inheritance

object

MqttClientExtensions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

DisconnectAsync(IMqttClient, MqttClientDisconnectOptionsReason, string, uint, List<MqttUserProperty>, CancellationToken)

public static Task DisconnectAsync(this IMqttClient client, MqttClientDisconnectOptionsReason reason = MqttClientDisconnectOptionsReason.NormalDisconnection, string reasonString = null, uint sessionExpiryInterval = 0, List<MqttUserProperty> userProperties = null, CancellationToken cancellationToken = default)

Parameters

client IMqttClient

reason MqttClientDisconnectOptionsReason

reasonString string

sessionExpiryInterval uint

userProperties List<MqttUserProperty>

cancellationToken CancellationToken

Returns

Task

PublishBinaryAsync(IMqttClient, string, IEnumerable<byte>, MqttQualityOfServiceLevel, bool, CancellationToken)

public static Task<MqttClientPublishResult> PublishBinaryAsync(this IMqttClient mqttClient, string topic, IEnumerable<byte> payload = null, MqttQualityOfServiceLevel qualityOfServiceLevel = MqttQualityOfServiceLevel.AtMostOnce, bool retain = false, CancellationToken cancellationToken = default)

Parameters

mqttClient IMqttClient

topic string

payload IEnumerable<byte>

qualityOfServiceLevel MqttQualityOfServiceLevel

retain bool

cancellationToken CancellationToken

Returns

Task<MqttClientPublishResult>

PublishStringAsync(IMqttClient, string, string, MqttQualityOfServiceLevel, bool, CancellationToken)

public static Task<MqttClientPublishResult> PublishStringAsync(this IMqttClient mqttClient, string topic, string payload = null, MqttQualityOfServiceLevel qualityOfServiceLevel = MqttQualityOfServiceLevel.AtMostOnce, bool retain = false, CancellationToken cancellationToken = default)

Parameters

mqttClient IMqttClient

topic string

payload string

qualityOfServiceLevel MqttQualityOfServiceLevel

retain bool

cancellationToken CancellationToken

Returns

Task<MqttClientPublishResult>

ReconnectAsync(IMqttClient, CancellationToken)

public static Task ReconnectAsync(this IMqttClient client, CancellationToken cancellationToken = default)

Parameters

client IMqttClient

cancellationToken CancellationToken

Returns

Task

SendExtendedAuthenticationExchangeDataAsync(IMqttClient, MqttExtendedAuthenticationExchangeData)

public static Task SendExtendedAuthenticationExchangeDataAsync(this IMqttClient client, MqttExtendedAuthenticationExchangeData data)

Parameters

client IMqttClient

data MqttExtendedAuthenticationExchangeData

Returns

Task

SubscribeAsync(IMqttClient, MqttTopicFilter, CancellationToken)

public static Task<MqttClientSubscribeResult> SubscribeAsync(this IMqttClient mqttClient, MqttTopicFilter topicFilter, CancellationToken cancellationToken = default)

Parameters

mqttClient IMqttClient

topicFilter MqttTopicFilter

cancellationToken CancellationToken

Returns

Task<MqttClientSubscribeResult>

SubscribeAsync(IMqttClient, string, MqttQualityOfServiceLevel, CancellationToken)

public static Task<MqttClientSubscribeResult> SubscribeAsync(this IMqttClient mqttClient, string topic, MqttQualityOfServiceLevel qualityOfServiceLevel = MqttQualityOfServiceLevel.AtMostOnce, CancellationToken cancellationToken = default)

Parameters

mqttClient IMqttClient

topic string

qualityOfServiceLevel MqttQualityOfServiceLevel

cancellationToken CancellationToken

Returns

Task<MqttClientSubscribeResult>

TryDisconnectAsync(IMqttClient, MqttClientDisconnectOptionsReason, string)

public static Task<bool> TryDisconnectAsync(this IMqttClient client, MqttClientDisconnectOptionsReason reason = MqttClientDisconnectOptionsReason.NormalDisconnection, string reasonString = null)

Parameters

client IMqttClient

reason MqttClientDisconnectOptionsReason

reasonString string

Returns

Task<bool>

TryPingAsync(IMqttClient, CancellationToken)

public static Task<bool> TryPingAsync(this IMqttClient client, CancellationToken cancellationToken = default)

Parameters

client IMqttClient

cancellationToken CancellationToken

Returns

Task<bool>

UnsubscribeAsync(IMqttClient, string, CancellationToken)

public static Task<MqttClientUnsubscribeResult> UnsubscribeAsync(this IMqttClient mqttClient, string topic, CancellationToken cancellationToken = default)

Parameters

mqttClient IMqttClient

topic string

cancellationToken CancellationToken

Returns

Task<MqttClientUnsubscribeResult>