TsgcWSRateLimiter › Properties

TsgcWSRateLimiter Properties

Published properties grouped by purpose, followed by the full alphabetical list.

Core

Name	Description
Enabled	Master switch that turns the entire rate limiter on or off.

Algorithms

Name	Description
TokenBucket	Token Bucket algorithm configuration: capacity plus refill rate for smooth bursts.
SlidingWindow	Sliding Window algorithm configuration: MaxRequests over a rolling WindowSec.
FixedWindow	Fixed Window algorithm configuration: MaxRequests inside a clock-aligned WindowSec.
BurstProtection	Short-timescale spike detector that puts abusive keys into a cooldown.

Scoping

Name	Description
PerIP	Rate-limit rule scoped to the source IP address.
PerAPIKey	Rate-limit rule scoped to an API-key identifier (keys prefixed apikey:).
PerUser	Rate-limit rule scoped to a user identifier (keys prefixed user:).
PerEndpoint	Collection of pattern-based rules matched by wildcard against the request key.
Quotas	Long-term caps (hour/day/month) evaluated on top of the main strategy.

Response

Name	Description
Response	Shape of the HTTP response returned for throttled requests (status, body, headers).

Persistence

Name	Description
StorageFile	Optional file path used by the state-persistence methods.

Diagnostics

Name	Description
Stats	Read-only counters with live statistics about evaluated and throttled requests.

All Properties (alphabetical)

Name	Description
BurstProtection	Short-timescale spike detector that puts abusive keys into a cooldown.
Enabled	Master switch that turns the entire rate limiter on or off.
FixedWindow	Fixed Window algorithm configuration: MaxRequests inside a clock-aligned WindowSec.
PerAPIKey	Rate-limit rule scoped to an API-key identifier (keys prefixed apikey:).
PerEndpoint	Collection of pattern-based rules matched by wildcard against the request key.
PerIP	Rate-limit rule scoped to the source IP address.
PerUser	Rate-limit rule scoped to a user identifier (keys prefixed user:).
Quotas	Long-term caps (hour/day/month) evaluated on top of the main strategy.
Response	Shape of the HTTP response returned for throttled requests (status, body, headers).
SlidingWindow	Sliding Window algorithm configuration: MaxRequests over a rolling WindowSec.
Stats	Read-only counters with live statistics about evaluated and throttled requests.
StorageFile	Optional file path used by the state-persistence methods.
TokenBucket	Token Bucket algorithm configuration: capacity plus refill rate for smooth bursts.