ThrottlingSentinelOptions Class

Definition

Namespace: Cuemon.AspNetCore.Http.Throttling

Assemblies: Cuemon.AspNetCore.dll

Source: src/Cuemon.AspNetCore/Http/Throttling/ThrottlingSentinelOptions.cs

Configuration options for ThrottlingSentinelMiddleware.

public class ThrottlingSentinelOptions : IValidatableParameterObject, IParameterObject

Inheritance: object

ThrottlingSentinelOptions

Implements: IValidatableParameterObject

IParameterObject

Examples

The following example shows how to create default and custom ThrottlingSentinelOptions to configure rate-limiting behavior. It demonstrates setting the quota, context resolver, header names, and retry-after scope, then validates the configuration and prints the selected values.

using System;
using Cuemon.AspNetCore.Http.Headers;
using Cuemon.AspNetCore.Http.Throttling;
using Microsoft.AspNetCore.Http;

namespace MyApp.Http.Throttling
{
    public class ThrottlingSentinelOptionsExample
    {
        public ThrottlingSentinelOptions CreateDefault()
        {
            // Default: RateLimit-Limit header, 429 response with Retry-After
            var options = new ThrottlingSentinelOptions();
            return options;
        }

        public ThrottlingSentinelOptions CreateCustom()
        {
            var options = new ThrottlingSentinelOptions
            {
                // Allow 60 requests per 1 minute window per client
                Quota = new ThrottleQuota(60, TimeSpan.FromMinutes(1)),
                // Resolve context by client IP address
                ContextResolver = ctx =>
                    ctx.Connection.RemoteIpAddress?.ToString() ?? "unknown",
                // Custom header names
                RateLimitHeaderName = "X-Rate-Limit-Limit",
                RateLimitRemainingHeaderName = "X-Rate-Limit-Remaining",
                RateLimitResetHeaderName = "X-Rate-Limit-Reset",
                // Use delta-seconds for Retry-After
                RateLimitResetScope = RetryConditionScope.DeltaSeconds,
                UseRetryAfterHeader = true,
                RetryAfterScope = RetryConditionScope.DeltaSeconds,
                // Custom response message
                TooManyRequestsMessage = "Rate limit exceeded. Please slow down."
            };

            // Validate the configuration
            options.ValidateOptions();

            Console.WriteLine($"Quota: {options.Quota.RateLimit} req / {options.Quota.Window.TotalMinutes} min");
            Console.WriteLine($"RateLimitHeader: {options.RateLimitHeaderName}");
            Console.WriteLine($"RetryAfterScope: {options.RetryAfterScope}");

            return options;
        }
    }
}

Constructors

Name	Description
ThrottlingSentinelOptions()	Initializes a new instance of the ThrottlingSentinelOptions class.

Properties

Name	Description
ContextResolver	Gets or sets the function delegate that will resolve a unique context of the throttling middleware (eg. IP-address, Authorization header, etc.).
Quota	Gets or sets the allowed quota for a given context.
RateLimitHeaderName	Gets or sets the name of the rate limit HTTP header.
RateLimitRemainingHeaderName	Gets or sets the name of the rate limit remaining HTTP header.
RateLimitResetHeaderName	Gets or sets the name of the rate limit reset HTTP header.
RateLimitResetScope	Gets or sets the preferred rate limit reset HTTP header value that conforms with RFC 7231.
ResponseHandler	Gets or sets the function delegate that configures the response in the form of a HttpResponseMessage.
RetryAfterScope	Gets or sets the preferred Retry-After HTTP header value that conforms with RFC 7231.
TooManyRequestsMessage	Gets or sets the message of a throttled request that has exceeded the rate limit.
UseRetryAfterHeader	Gets or sets a value indicating whether to include a Retry-After HTTP header specifying how long to wait before making a new request.

Methods