FixedWindowRateLimiterOptions Class

Definition

Namespace:

System.Threading.RateLimiting

Assembly:

System.Threading.RateLimiting.dll

Package:

Microsoft.AspNetCore.App.Ref v8.0.0

Source:

FixedWindowRateLimiterOptions.cs

Options to specify the behavior of a FixedWindowRateLimiter.

public sealed class FixedWindowRateLimiterOptions

type FixedWindowRateLimiterOptions = class

Public NotInheritable Class FixedWindowRateLimiterOptions

Inheritance

Object

FixedWindowRateLimiterOptions

Constructors

FixedWindowRateLimiterOptions()

Properties

AutoReplenishment	Specified whether the FixedWindowRateLimiter is automatically refresh counters or if someone else will be calling TryReplenish() to refresh counters.
PermitLimit	Maximum number of permit counters that can be allowed in a window. Must be set to a value > 0 by the time these options are passed to the constructor of FixedWindowRateLimiter.
QueueLimit	Maximum cumulative permit count of queued acquisition requests. Must be set to a value >= 0 by the time these options are passed to the constructor of FixedWindowRateLimiter.
QueueProcessingOrder	Determines the behaviour of AcquireAsync(Int32, CancellationToken) when not enough resources can be leased.
Window	Specifies the time window that takes in the requests. Must be set to a value greater than Zero by the time these options are passed to the constructor of FixedWindowRateLimiter.