Class MessagingOptions

Namespace

ProtoTest.Messaging

Assembly

ProtoTest.Messaging.dll

Messaging defaults, layered from ProtoTest:Messaging over the code-based registration.

public sealed class MessagingOptions : IProtoConfigurableOptions

Inheritance

object

MessagingOptions

Implements

IProtoConfigurableOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ProtoConfigurableOptionsExtensions.BindFromConfiguration(IProtoConfigurableOptions, IConfiguration)

SheetModelAssertions.ShouldMatchShape<TRow>(TRow, object, bool, JsonSerializerOptions?)

SheetModelAssertions.ShouldMatchShape<TRow>(TRow, object, JsonSerializerOptions?)

Fields

ConfigurationSectionName

public const string ConfigurationSectionName = "ProtoTest:Messaging"

Field Value

string

Properties

DeclaredDestinations

Destinations this suite declares on the broker - the ones it owns and publishes to itself - configured for the run; an adapter that owns broker topology creates each of them during test setup, before any tap binds. Declare them in code with ProtoMessagingBuilder.Declare or under ProtoTest:Messaging:DeclaredDestinations; configuration binds after code and can add values. Declaration is idempotent: an existing destination is left as it is and a repeated declaration is a no-op. A broker whose destinations always exist (the in-memory broker) treats a declaration as a no-op.

public IList<string> DeclaredDestinations { get; set; }

Property Value

IList<string>

DefaultTimeout

How long AwaitAsync waits when the caller does not name a timeout.

public TimeSpan DefaultTimeout { get; set; }

Property Value

TimeSpan

Destinations

Destinations this suite awaits, configured for the run; an adapter declares the test's per-test taps from it before the system under test publishes. Declare them in code with ProtoMessagingBuilder.Tap or under ProtoTest:Messaging:Destinations; configuration binds after code and can add values. Pre-bind every destination the act publishes to - a tap declared at the first await misses earlier messages. Optional for brokers that keep history.

public IList<string> Destinations { get; set; }

Property Value

IList<string>

Methods

Validate()

Validates the resolved options once, after code callbacks and configuration have been applied. A bad value is a configuration error and must throw here rather than fail the first test that happens to use it. The default does nothing.

public void Validate()