Table of Contents

Class RateLimitOptions

Namespace
Excalibur.Dispatch.Middleware.Resilience
Assembly
Excalibur.Dispatch.dll

Options for a specific rate limit.

public sealed class RateLimitOptions
Inheritance
RateLimitOptions
Inherited Members
Extension Methods

Properties

Algorithm

Gets or sets the rate limiting algorithm to use.

public MiddlewareRateLimitAlgorithm Algorithm { get; set; }

Property Value

MiddlewareRateLimitAlgorithm

The current Algorithm value.

PermitLimit

Gets or sets the maximum number of permits allowed for sliding/fixed window algorithms.

[Range(1, 2147483647)]
public int PermitLimit { get; set; }

Property Value

int

The current PermitLimit value.

ReplenishmentPeriod

Gets or sets the period for replenishing tokens in the bucket.

public TimeSpan ReplenishmentPeriod { get; set; }

Property Value

TimeSpan

The period for replenishing tokens in the bucket.

SegmentsPerWindow

Gets or sets the number of segments per window for sliding window algorithm.

[Range(1, 2147483647)]
public int SegmentsPerWindow { get; set; }

Property Value

int

The current SegmentsPerWindow value.

TokenLimit

Gets or sets the maximum number of tokens in the bucket for token bucket algorithm.

[Range(1, 2147483647)]
public int TokenLimit { get; set; }

Property Value

int

The current TokenLimit value.

TokensPerPeriod

Gets or sets the number of tokens to add per replenishment period.

[Range(1, 2147483647)]
public int TokensPerPeriod { get; set; }

Property Value

int

The current TokensPerPeriod value.

Window

Gets or sets the time window duration for sliding/fixed window algorithms.

public TimeSpan Window { get; set; }

Property Value

TimeSpan

The time window duration for sliding/fixed window algorithms.