Class OutboxStagingOptions
- Namespace
- Excalibur.Dispatch.Options.Middleware
- Assembly
- Excalibur.Dispatch.dll
Configuration options for outbox staging middleware.
public sealed class OutboxStagingOptions
- Inheritance
-
OutboxStagingOptions
- Inherited Members
- Extension Methods
Properties
BypassOutboxForTypes
Gets or sets message types that bypass outbox staging.
public string[]? BypassOutboxForTypes { get; set; }
Property Value
- string[]
The current BypassOutboxForTypes value.
CompressMessageData
Gets or sets a value indicating whether to compress message data in the outbox.
public bool CompressMessageData { get; set; }
Property Value
- bool
Default is false.
ConsistencyMode
Gets or sets the outbox consistency mode. This is a STARTUP REQUIREMENT, not a behaviour selector: setting it to Transactional makes startup fail unless the transactional infrastructure this package can see is registered. It does not choose a write path.
public OutboxConsistencyMode ConsistencyMode { get; set; }
Property Value
- OutboxConsistencyMode
Default is EventuallyConsistent.
Remarks
What it checks, and what it cannot. The validator confirms an outbox store and the transaction middleware are registered. It cannot confirm that an event store supports transactional staging, because that capability is declared in the event-sourcing packages and this package does not depend on them. A configuration that satisfies this option can therefore still resolve to an eventually-consistent write path at runtime.
Which switch selects the path. For event-sourced aggregates the write path is chosen by the staging strategy on the event-sourcing builder, which prefers the transactional path when both a transactional outbox writer and a transactional event store are present and falls back otherwise. Setting this option does not change that choice; it only refuses to start without the parts it can see.
Enabled
Gets or sets a value indicating whether outbox staging is enabled.
public bool Enabled { get; set; }
Property Value
- bool
Default is true.
MaxOutboundMessagesPerOperation
Gets or sets the maximum number of outbound messages to stage per processing operation.
public int MaxOutboundMessagesPerOperation { get; set; }
Property Value
- int
Default is 100.