ktor-rate-limiting/dev.forst.ktor.ratelimiting/RateLimitingConfiguration

RateLimitingConfiguration

class RateLimitingConfiguration

Configuration for the Rate Limiting plugin.

Constructors

RateLimitingConfiguration

fun RateLimitingConfiguration()

Functions

excludeRequestWhen

fun excludeRequestWhen(body: RateLimitExclusion)

Define selector that excludes given route from the rate limiting completely.

fun rateLimitHit(action: RateLimitHitAction)

Action that is executed when the rate limit is hit.

fun registerLimit(limit: Long, window: Duration, extractKey: RateLimitKeyExtraction)

Register a single limit for the rate limiter.

Properties

var interceptPhase: Hook<suspend (ApplicationCall) -> Unit>

Determines which hook to use to catch the call.

purgeHitDuration

var purgeHitDuration: Duration

See LinearRateLimiter.purgeHitDuration.

var purgeHitSize: Int

See LinearRateLimiter.purgeHitSize.

Sources

Ktor Rate Limiting source