Share via


SlidingWindowRateLimiterOptions Class

Definition

Options to specify the behavior of a SlidingWindowRateLimiter.

public sealed class SlidingWindowRateLimiterOptions
type SlidingWindowRateLimiterOptions = class
Public NotInheritable Class SlidingWindowRateLimiterOptions
Inheritance
SlidingWindowRateLimiterOptions

Constructors

SlidingWindowRateLimiterOptions()

Properties

AutoReplenishment

Specified whether the SlidingWindowRateLimiter is automatically replenishing request counters or if someone else will be calling TryReplenish() to replenish tokens.

PermitLimit

Maximum number of requests that can be served in a window. Must be set to a value > 0 by the time these options are passed to the constructor of SlidingWindowRateLimiter.

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 SlidingWindowRateLimiter.

QueueProcessingOrder

Determines the behaviour of AcquireAsync(Int32, CancellationToken) when not enough resources can be leased.

SegmentsPerWindow

Specifies the maximum number of segments a window is divided into. Must be set to a value > 0 by the time these options are passed to the constructor of SlidingWindowRateLimiter.

Window

Specifies the minimum period between replenishments. Must be set to a value greater than Zero by the time these options are passed to the constructor of SlidingWindowRateLimiter.

Applies to