Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

FixedWindowRateLimiterOptions Class

Definition

Namespace:
System.Threading.RateLimiting
Assembly:
System.Threading.RateLimiting.dll
Package:
System.Threading.RateLimiting v11.0.0-preview.5.26302.115
Source:
FixedWindowRateLimiterOptions.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Options to specify the behavior of a FixedWindowRateLimiter.

public ref class FixedWindowRateLimiterOptions sealed
public sealed class FixedWindowRateLimiterOptions
type FixedWindowRateLimiterOptions = class
Public NotInheritable Class FixedWindowRateLimiterOptions
Inheritance
FixedWindowRateLimiterOptions

Constructors

Name Description
FixedWindowRateLimiterOptions()

Properties

Name Description
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.

Applies to


Feedback

Was this page helpful?