Table of Contents

Class MongoDbOutboxOptions

Namespace
Excalibur.Outbox.MongoDB
Assembly
Excalibur.Outbox.MongoDB.dll

Configuration options for the MongoDB outbox store.

public sealed class MongoDbOutboxOptions
Inheritance
MongoDbOutboxOptions
Inherited Members

Properties

CollectionName

Gets or sets the collection name for outbox messages.

[Required]
public string CollectionName { get; set; }

Property Value

string

ConnectTimeoutSeconds

Gets or sets the connection timeout in seconds.

[Range(1, 2147483647)]
public int ConnectTimeoutSeconds { get; set; }

Property Value

int

ConnectionString

Gets or sets the MongoDB connection string.

[Required]
public string ConnectionString { get; set; }

Property Value

string

DatabaseName

Gets or sets the database name.

[Required]
public string DatabaseName { get; set; }

Property Value

string

FailureBackoffFloorSeconds

Gets or sets the failure-backoff floor F, in seconds: after MarkFailedAsync(string, string, int, CancellationToken) records a plain failure, the message becomes re-claimable only after F has elapsed (its NextAttemptAt gate). This bounds the retry cadence of the plain (no fine-grained backoff) path so it cannot hot-loop the drain, while the message remains eventually re-claimable (at-least-once). F must exceed the drain polling interval; the validator enforces that cross-options invariant.

[Range(1, 2147483647)]
public int FailureBackoffFloorSeconds { get; set; }

Property Value

int

The failure-backoff floor in seconds. Defaults to 30 (uniform across the outbox family).

LeaseTimeoutSeconds

Gets or sets the number of seconds a claim lease is honored before it is considered stale and eligible for reclamation by another poller (crash recovery).

[Range(1, 2147483647)]
public int LeaseTimeoutSeconds { get; set; }

Property Value

int

MaxPoolSize

Gets or sets the maximum connection pool size.

[Range(1, 2147483647)]
public int MaxPoolSize { get; set; }

Property Value

int

ProcessorId

Gets or sets the identifier this process uses when atomically claiming a batch of messages, persisted as the claimed document's lease owner. Defaults to a value unique per machine and process so that concurrent pollers never collide.

[Required]
public string ProcessorId { get; set; }

Property Value

string

SentMessageTtlSeconds

Gets or sets the default time to live for sent messages in seconds.

[Range(0, 2147483647)]
public int SentMessageTtlSeconds { get; set; }

Property Value

int

Remarks

Set to 0 for no expiration. Defaults to 7 days (604800 seconds). Uses MongoDB TTL index on SentAt field.

ServerSelectionTimeoutSeconds

Gets or sets the server selection timeout in seconds.

[Range(1, 2147483647)]
public int ServerSelectionTimeoutSeconds { get; set; }

Property Value

int

UseSsl

Gets or sets a value indicating whether to use SSL/TLS.

public bool UseSsl { get; set; }

Property Value

bool

Methods

Validate()

Validates the options and throws if invalid.

public void Validate()

Exceptions

InvalidOperationException

Thrown when required options are missing.