Class InboxOptions
Provides configuration options for inbox pattern implementations, controlling message processing behavior, performance characteristics, and reliability features. These options enable fine-tuning of inbox processors for different deployment scenarios and performance requirements.
public sealed class InboxOptions
- Inheritance
-
InboxOptions
- Inherited Members
- Extension Methods
Remarks
Inbox options control various aspects of the inbox pattern implementation including batching behavior, deduplication handling, retry policies, and performance optimizations. Proper configuration of these options is essential for achieving optimal performance and reliability in high-throughput messaging scenarios. The options include validation logic to ensure consistent and valid configuration values.
Properties
BatchTuning
Gets or sets the batch tuning options controlling database batching, timeouts, and dynamic sizing.
public InboxBatchTuningOptions BatchTuning { get; set; }
Property Value
- InboxBatchTuningOptions
The batch tuning options.
Capacity
Gets or sets the capacity and throughput options controlling queue sizes, batch sizes, and parallelism.
public InboxCapacityOptions Capacity { get; set; }
Property Value
- InboxCapacityOptions
The capacity options.
Deduplication
Gets or sets the deduplication options for inbox message processing.
public DeduplicationOptions Deduplication { get; set; }
Property Value
- DeduplicationOptions
The deduplication options for inbox message processing.
DefaultMessageTimeToLive
Gets or sets the default time-to-live for messages in the inbox before they expire.
public TimeSpan? DefaultMessageTimeToLive { get; set; }
Property Value
- TimeSpan?
A nullable TimeSpan representing the message expiration time, or
nullif messages should not expire by default.
DuplicateBehavior
Gets or sets the behavior when duplicate messages are encountered during inbox processing. This setting controls how the system responds to messages that have already been processed.
public SkipBehavior DuplicateBehavior { get; set; }
Property Value
- SkipBehavior
A SkipBehavior value indicating how to handle duplicate messages. The default value is Silent.
Remarks
The duplicate behavior setting affects both performance and observability of the inbox system. Silent skipping provides the best performance but may hide potential issues with message producers. Other behaviors may log warnings or take additional actions to improve system visibility.
MaxAttempts
Gets or sets the maximum number of processing attempts for failed messages.
[Range(1, 2147483647)]
public int MaxAttempts { get; set; }
Property Value
- int
An integer representing the maximum number of times a failed message will be retried. Must be greater than zero.
Methods
Validate(InboxOptions)
Validates the configured option values.
public static string? Validate(InboxOptions options)
Parameters
optionsInboxOptionsThe options instance to validate.
Returns
- string
An error message if validation fails; otherwise
null.