Interface IMqttClient

Namespace

MQTTnet.Client

Assembly

MQTTnet.dll

public interface IMqttClient : IDisposable

Inherited Members

IDisposable.Dispose()

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)

Properties

IsConnected

bool IsConnected { get; }

Property Value

bool

Options

MqttClientOptions Options { get; }

Property Value

MqttClientOptions

Methods

ConnectAsync(MqttClientOptions, CancellationToken)

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

Parameters

options MqttClientOptions

cancellationToken CancellationToken

Returns

Task<MqttClientConnectResult>

DisconnectAsync(MqttClientDisconnectOptions, CancellationToken)

Task DisconnectAsync(MqttClientDisconnectOptions options, CancellationToken cancellationToken = default)

Parameters

options MqttClientDisconnectOptions

cancellationToken CancellationToken

Returns

Task

PingAsync(CancellationToken)

Task PingAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task

PublishAsync(MqttApplicationMessage, CancellationToken)

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

Parameters

applicationMessage MqttApplicationMessage

cancellationToken CancellationToken

Returns

Task<MqttClientPublishResult>

SendExtendedAuthenticationExchangeDataAsync(MqttExtendedAuthenticationExchangeData, CancellationToken)

Task SendExtendedAuthenticationExchangeDataAsync(MqttExtendedAuthenticationExchangeData data, CancellationToken cancellationToken = default)

Parameters

data MqttExtendedAuthenticationExchangeData

cancellationToken CancellationToken

Returns

Task

SubscribeAsync(MqttClientSubscribeOptions, CancellationToken)

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

Parameters

options MqttClientSubscribeOptions

cancellationToken CancellationToken

Returns

Task<MqttClientSubscribeResult>

UnsubscribeAsync(MqttClientUnsubscribeOptions, CancellationToken)

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

Parameters

options MqttClientUnsubscribeOptions

cancellationToken CancellationToken

Returns

Task<MqttClientUnsubscribeResult>

Events

ApplicationMessageReceivedAsync

event Func<MqttApplicationMessageReceivedEventArgs, Task> ApplicationMessageReceivedAsync

Event Type

Func<MqttApplicationMessageReceivedEventArgs, Task>

ConnectedAsync

event Func<MqttClientConnectedEventArgs, Task> ConnectedAsync

Event Type

Func<MqttClientConnectedEventArgs, Task>

ConnectingAsync

event Func<MqttClientConnectingEventArgs, Task> ConnectingAsync

Event Type

Func<MqttClientConnectingEventArgs, Task>

DisconnectedAsync

event Func<MqttClientDisconnectedEventArgs, Task> DisconnectedAsync

Event Type

Func<MqttClientDisconnectedEventArgs, Task>

InspectPacketAsync

event Func<InspectMqttPacketEventArgs, Task> InspectPacketAsync

Event Type

Func<InspectMqttPacketEventArgs, Task>