ktor-server-rate-limit/io.ktor.server.plugins.ratelimit/RateLimitProviderConfig

RateLimitProviderConfig

class RateLimitProviderConfig(name: RateLimitName)

A config for RateLimit provider inside RateLimiterConfig.

Constructors

fun RateLimitProviderConfig(name: RateLimitName)

Functions

modifyResponse

fun modifyResponse(block: (ApplicationCall, RateLimiter.State) -> Unit)

Sets a function that modifies response headers. By default, these headers will be added:

rateLimiter

fun rateLimiter(provider: (call: ApplicationCall, key: Any) -> RateLimiter)

Sets RateLimit for this provider based on ApplicationCall and key of this request.

fun rateLimiter(limit: Int, refillPeriod: Duration, initialSize: Int = limit, clock: () -> Long = { getTimeMillis() })

Sets RateLimit for this provider

requestKey

fun requestKey(block: suspend (ApplicationCall) -> Any)

Sets a function that returns a key for a request. Requests with different keys will have independent Rate-Limits. Keys should have good equals and hashCode implementations. By default, the key is a Unit, so all requests share the same Rate-Limit.

requestWeight

fun requestWeight(block: suspend (ApplicationCall, key: Any) -> Int)

Sets a function that returns a weight of a request. Weight is used to calculate how many tokens are consumed by a request. By default, weight is always 1.