Interface IMqttTestingHelper

Namespace

Silverback.Testing

Assembly

Silverback.Integration.MQTT.Testing.dll

Exposes some helper methods and shortcuts to simplify testing.

public interface IMqttTestingHelper : ITestingHelper

Inherited Members

ITestingHelper.GetConsumer(string)

ITestingHelper.GetConsumerForEndpoint(string)

ITestingHelper.GetProducerForEndpoint(string)

ITestingHelper.WaitUntilConnectedAsync(TimeSpan?)

ITestingHelper.WaitUntilConnectedAsync(bool, TimeSpan?)

ITestingHelper.WaitUntilConnectedAsync(CancellationToken)

ITestingHelper.WaitUntilConnectedAsync(bool, CancellationToken)

ITestingHelper.WaitUntilAllMessagesAreConsumedAsync(params string[])

ITestingHelper.WaitUntilAllMessagesAreConsumedAsync(TimeSpan?, params string[])

ITestingHelper.WaitUntilAllMessagesAreConsumedAsync(bool, params string[])

ITestingHelper.WaitUntilAllMessagesAreConsumedAsync(bool, TimeSpan?)

ITestingHelper.WaitUntilAllMessagesAreConsumedAsync(bool, TimeSpan?, params string[])

ITestingHelper.WaitUntilAllMessagesAreConsumedAsync(CancellationToken, params string[])

ITestingHelper.WaitUntilAllMessagesAreConsumedAsync(bool, CancellationToken, params string[])

ITestingHelper.WaitUntilOutboxIsEmptyAsync(TimeSpan?)

ITestingHelper.WaitUntilOutboxIsEmptyAsync(CancellationToken)

ITestingHelper.IsOutboxEmptyAsync()

ITestingHelper.Spy

Methods

GetClientSession(string)

Gets the IClientSession of the specified client.

IClientSession GetClientSession(string clientId)

Parameters

clientId string

The client id.

Returns

IClientSession

The IClientSession.

Remarks

This method works with the mocked MQTT broker only. See UseMockedMqtt(SilverbackBuilder, Action<IMockedMqttOptionsBuilder>?) or AddMockedMqtt(BrokerOptionsBuilder, Action<IMockedMqttOptionsBuilder>?).

GetMessages(string)

Gets the messages that have been published to the specified topic.

IReadOnlyList<MqttApplicationMessage> GetMessages(string topic)

Parameters

topic string

The topic.

Returns

IReadOnlyList<MqttApplicationMessage>

The messages published to the topic.

Remarks

This method works with the mocked MQTT broker only. See UseMockedMqtt(SilverbackBuilder, Action<IMockedMqttOptionsBuilder>?) or AddMockedMqtt(BrokerOptionsBuilder, Action<IMockedMqttOptionsBuilder>?).

GetProducer(Action<MqttClientConfigurationBuilder>)

Gets a new producer with the specified configuration.

IProducer GetProducer(Action<MqttClientConfigurationBuilder> configurationBuilderAction)

Parameters

configurationBuilderAction Action<MqttClientConfigurationBuilder>

An Action<T> that takes the MqttClientConfigurationBuilder and configures it.

Returns

IProducer

The IProducer.