Class MqttClient

Namespace

MQTTnet.Client

Assembly

MQTTnet.dll

public sealed class MqttClient : Disposable, IMqttClient, IDisposable

Inheritance

object

Disposable

MqttClient

Implements

IMqttClient

IDisposable

Inherited Members

Disposable.Dispose()

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

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

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

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

MqttClientExtensions.ReconnectAsync(IMqttClient, CancellationToken)

MqttClientExtensions.SendExtendedAuthenticationExchangeDataAsync(IMqttClient, MqttExtendedAuthenticationExchangeData)

MqttClientExtensions.SubscribeAsync(IMqttClient, MqttTopicFilter, CancellationToken)

MqttClientExtensions.SubscribeAsync(IMqttClient, string, MqttQualityOfServiceLevel, CancellationToken)

MqttClientExtensions.TryDisconnectAsync(IMqttClient, MqttClientDisconnectOptionsReason, string)

MqttClientExtensions.TryPingAsync(IMqttClient, CancellationToken)

MqttClientExtensions.UnsubscribeAsync(IMqttClient, string, CancellationToken)

Constructors

MqttClient(IMqttClientAdapterFactory, IMqttNetLogger)

public MqttClient(IMqttClientAdapterFactory channelFactory, IMqttNetLogger logger)

Parameters

channelFactory IMqttClientAdapterFactory

logger IMqttNetLogger

Properties

IsConnected

public bool IsConnected { get; }

Property Value

bool

Options

public MqttClientOptions Options { get; }

Property Value

MqttClientOptions

Methods

ConnectAsync(MqttClientOptions, CancellationToken)

public Task<MqttClientConnectResult> ConnectAsync(MqttClientOptions options, CancellationToken cancellationToken = default)

Parameters

options MqttClientOptions

cancellationToken CancellationToken

Returns

Task<MqttClientConnectResult>

DisconnectAsync(MqttClientDisconnectOptions, CancellationToken)

public Task DisconnectAsync(MqttClientDisconnectOptions options, CancellationToken cancellationToken = default)

Parameters

options MqttClientDisconnectOptions

cancellationToken CancellationToken

Returns

Task

Dispose(bool)

protected override void Dispose(bool disposing)

Parameters

disposing bool

PingAsync(CancellationToken)

public Task PingAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task

PublishAsync(MqttApplicationMessage, CancellationToken)

public Task<MqttClientPublishResult> PublishAsync(MqttApplicationMessage applicationMessage, CancellationToken cancellationToken = default)

Parameters

applicationMessage MqttApplicationMessage

cancellationToken CancellationToken

Returns

Task<MqttClientPublishResult>

SendExtendedAuthenticationExchangeDataAsync(MqttExtendedAuthenticationExchangeData, CancellationToken)

public Task SendExtendedAuthenticationExchangeDataAsync(MqttExtendedAuthenticationExchangeData data, CancellationToken cancellationToken = default)

Parameters

data MqttExtendedAuthenticationExchangeData

cancellationToken CancellationToken

Returns

Task

SubscribeAsync(MqttClientSubscribeOptions, CancellationToken)

public Task<MqttClientSubscribeResult> SubscribeAsync(MqttClientSubscribeOptions options, CancellationToken cancellationToken = default)

Parameters

options MqttClientSubscribeOptions

cancellationToken CancellationToken

Returns

Task<MqttClientSubscribeResult>

UnsubscribeAsync(MqttClientUnsubscribeOptions, CancellationToken)

public Task<MqttClientUnsubscribeResult> UnsubscribeAsync(MqttClientUnsubscribeOptions options, CancellationToken cancellationToken = default)

Parameters

options MqttClientUnsubscribeOptions

cancellationToken CancellationToken

Returns

Task<MqttClientUnsubscribeResult>

Events

ApplicationMessageReceivedAsync

public event Func<MqttApplicationMessageReceivedEventArgs, Task> ApplicationMessageReceivedAsync

Event Type

Func<MqttApplicationMessageReceivedEventArgs, Task>

ConnectedAsync

public event Func<MqttClientConnectedEventArgs, Task> ConnectedAsync

Event Type

Func<MqttClientConnectedEventArgs, Task>

ConnectingAsync

public event Func<MqttClientConnectingEventArgs, Task> ConnectingAsync

Event Type

Func<MqttClientConnectingEventArgs, Task>

DisconnectedAsync

public event Func<MqttClientDisconnectedEventArgs, Task> DisconnectedAsync

Event Type

Func<MqttClientDisconnectedEventArgs, Task>

InspectPacketAsync

public event Func<InspectMqttPacketEventArgs, Task> InspectPacketAsync

Event Type

Func<InspectMqttPacketEventArgs, Task>