Class MockedMqttClient

Namespace

Silverback.Messaging.Broker.Mqtt.Mocks

Assembly

Silverback.Integration.MQTT.Testing.dll

A mocked implementation of MQTTnet.IMqttClient from MQTTnet that connects with an in-memory broker.

public sealed class MockedMqttClient : IMqttClient, IDisposable

Inheritance

object

MockedMqttClient

Implements

IMqttClient

IDisposable

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

MockedMqttClient(IInMemoryMqttBroker, IMockedMqttOptions)

Initializes a new instance of the MockedMqttClient class.

public MockedMqttClient(IInMemoryMqttBroker broker, IMockedMqttOptions mockOptions)

Parameters

broker IInMemoryMqttBroker

The IInMemoryMqttBroker.

mockOptions IMockedMqttOptions

The IMockedMqttOptions.

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()

public void Dispose()

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>

SendEnhancedAuthenticationExchangeDataAsync(MqttEnhancedAuthenticationExchangeData, CancellationToken)

public Task SendEnhancedAuthenticationExchangeDataAsync(MqttEnhancedAuthenticationExchangeData data, CancellationToken cancellationToken = default)

Parameters

data MqttEnhancedAuthenticationExchangeData

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>