Class MockedMqttClient

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

Inheritance
System.Object
MockedMqttClient
Implements
MQTTnet.Client.IMqttClient
System.IDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Silverback.Messaging.Broker.Mqtt.Mocks
Assembly: Silverback.Integration.MQTT.Testing.dll
Syntax
public sealed class MockedMqttClient : IMqttClient, IDisposable

Constructors

| Improve this doc View source

MockedMqttClient(IInMemoryMqttBroker, IMockedMqttOptions)

Initializes a new instance of the MockedMqttClient class.

Declaration
public MockedMqttClient(IInMemoryMqttBroker broker, IMockedMqttOptions mockOptions)
Parameters
Type Name Description
IInMemoryMqttBroker broker

The IInMemoryMqttBroker.
IMockedMqttOptions mockOptions

The IMockedMqttOptions.

Properties

| Improve this doc View source

IsConnected

Declaration
public bool IsConnected { get; }
Property Value
Type Description
System.Boolean
| Improve this doc View source

IsConsumerConnected

Gets a value indicating whether the client is connected and a message handler is bound to it.

Declaration
public bool IsConsumerConnected { get; }
Property Value
Type Description
System.Boolean
| Improve this doc View source

Options

Declaration
public MqttClientOptions Options { get; }
Property Value
Type Description
MQTTnet.Client.MqttClientOptions

Methods

| Improve this doc View source

ConnectAsync(MqttClientOptions, CancellationToken)

Declaration
public async Task<MqttClientConnectResult> ConnectAsync(MqttClientOptions options, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
MQTTnet.Client.MqttClientOptions options
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<MQTTnet.Client.MqttClientConnectResult>
| Improve this doc View source

DisconnectAsync(MqttClientDisconnectOptions, CancellationToken)

Declaration
public async Task DisconnectAsync(MqttClientDisconnectOptions options, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
MQTTnet.Client.MqttClientDisconnectOptions options
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task
| Improve this doc View source

Dispose()

Declaration
public void Dispose()
| Improve this doc View source

PingAsync(CancellationToken)

Declaration
public Task PingAsync(CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task
| Improve this doc View source

PublishAsync(MqttApplicationMessage, CancellationToken)

Declaration
public async Task<MqttClientPublishResult> PublishAsync(MqttApplicationMessage applicationMessage, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
MQTTnet.MqttApplicationMessage applicationMessage
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<MQTTnet.Client.MqttClientPublishResult>
| Improve this doc View source

SendExtendedAuthenticationExchangeDataAsync(MqttExtendedAuthenticationExchangeData, CancellationToken)

Declaration
public Task SendExtendedAuthenticationExchangeDataAsync(MqttExtendedAuthenticationExchangeData data, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
MQTTnet.Client.MqttExtendedAuthenticationExchangeData data
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task
| Improve this doc View source

SubscribeAsync(MqttClientSubscribeOptions, CancellationToken)

Declaration
public Task<MqttClientSubscribeResult> SubscribeAsync(MqttClientSubscribeOptions options, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
MQTTnet.Client.MqttClientSubscribeOptions options
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<MQTTnet.Client.MqttClientSubscribeResult>
| Improve this doc View source

UnsubscribeAsync(MqttClientUnsubscribeOptions, CancellationToken)

Declaration
public Task<MqttClientUnsubscribeResult> UnsubscribeAsync(MqttClientUnsubscribeOptions options, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
MQTTnet.Client.MqttClientUnsubscribeOptions options
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<MQTTnet.Client.MqttClientUnsubscribeResult>

Events

| Improve this doc View source

ApplicationMessageReceivedAsync

Declaration
public event Func<MqttApplicationMessageReceivedEventArgs, Task> ApplicationMessageReceivedAsync
Event Type
Type Description
System.Func<MQTTnet.Client.MqttApplicationMessageReceivedEventArgs, System.Threading.Tasks.Task>
| Improve this doc View source

ConnectedAsync

Declaration
public event Func<MqttClientConnectedEventArgs, Task> ConnectedAsync
Event Type
Type Description
System.Func<MQTTnet.Client.MqttClientConnectedEventArgs, System.Threading.Tasks.Task>
| Improve this doc View source

ConnectingAsync

Declaration
public event Func<MqttClientConnectingEventArgs, Task> ConnectingAsync
Event Type
Type Description
System.Func<MQTTnet.Client.MqttClientConnectingEventArgs, System.Threading.Tasks.Task>
| Improve this doc View source

DisconnectedAsync

Declaration
public event Func<MqttClientDisconnectedEventArgs, Task> DisconnectedAsync
Event Type
Type Description
System.Func<MQTTnet.Client.MqttClientDisconnectedEventArgs, System.Threading.Tasks.Task>
| Improve this doc View source

InspectPacketAsync

Declaration
public event Func<InspectMqttPacketEventArgs, Task> InspectPacketAsync
Event Type
Type Description
System.Func<MQTTnet.Diagnostics.InspectMqttPacketEventArgs, System.Threading.Tasks.Task>

Implements

MQTTnet.Client.IMqttClient
System.IDisposable