Class ThrottlingMiddleware
- Namespace
- Excalibur.Dispatch.Middleware.Resilience
- Assembly
- Excalibur.Dispatch.dll
Middleware that implements throughput throttling to protect the system from excessive message processing and prevent resource exhaustion.
[AppliesTo(MessageKinds.Action|MessageKinds.Event)]
public sealed class ThrottlingMiddleware : IDispatchMiddleware, IAsyncDisposable, IDisposable
- Inheritance
-
ThrottlingMiddleware
- Implements
- Inherited Members
- Extension Methods
Remarks
This middleware provides system-level throughput protection using per-message-type, per-tenant, and global rate limiting with multiple algorithms (token bucket, sliding window, fixed window, concurrency).
For identity-based abuse prevention (per-user, per-API-key, per-IP rate limiting),
see Excalibur.Security.RateLimitingMiddleware instead.
Constructors
ThrottlingMiddleware(IOptions<RateLimitingOptions>, ILogger<ThrottlingMiddleware>)
Initializes a new instance of the ThrottlingMiddleware class.
public ThrottlingMiddleware(IOptions<RateLimitingOptions> options, ILogger<ThrottlingMiddleware> logger)
Parameters
optionsIOptions<RateLimitingOptions>loggerILogger<ThrottlingMiddleware>
Properties
ApplicableMessageKinds
Gets the message kinds that this middleware applies.
public MessageKinds ApplicableMessageKinds { get; }
Property Value
- MessageKinds
The set of message kinds this middleware applies to.
Remarks
Specifies which types of messages this middleware should process. The pipeline filters middleware based on these flags, ensuring only relevant middleware processes each message. This improves performance and allows middleware to specialize in handling specific message types. If not implemented, defaults to All for backward compatibility.
Stage
Gets the pipeline stage where this middleware should execute.
public DispatchMiddlewareStage? Stage { get; }
Property Value
- DispatchMiddlewareStage?
The pipeline stage for this middleware.
Remarks
The stage determines the execution order of middleware in the pipeline. If null, the middleware will be registered at the end of the pipeline. Stages are processed in numeric order, allowing fine-grained control over middleware execution sequence.
Methods
Dispose()
Disposes all rate limiters synchronously.
public void Dispose()
DisposeAsync()
Disposes all rate limiters asynchronously.
public ValueTask DisposeAsync()
Returns
InvokeAsync(IDispatchMessage, IMessageContext, DispatchRequestDelegate, CancellationToken)
Processes the message within the middleware pipeline.
public ValueTask<IMessageResult> InvokeAsync(IDispatchMessage message, IMessageContext context, DispatchRequestDelegate nextDelegate, CancellationToken cancellationToken)
Parameters
messageIDispatchMessageThe message being processed.
contextIMessageContextThe message context containing metadata and processing state.
nextDelegateDispatchRequestDelegateThe delegate to invoke the next middleware in the pipeline.
cancellationTokenCancellationTokenThe cancellation token to observe.
Returns
- ValueTask<IMessageResult>
A ValueTask<TResult> representing the result of message processing, potentially modified by this middleware. ValueTask can avoid allocating a Task for a synchronously completed result; other dispatch work can still allocate.
Remarks
Implementations can execute logic before calling nextDelegate, after calling it, or both. To short-circuit the pipeline, don't call nextDelegate and return an appropriate result. The context can be used to share data between middleware components. Respect the cancellation token to support timeouts and graceful shutdown.
Exceptions
- ArgumentNullException
Thrown when message, context, or nextDelegate is null.
- OperationCanceledException
Thrown when the operation is cancelled.