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

Package-level declarations

Types

RateLimitConfig

class RateLimitConfig

A config for the RateLimit plugin.

RateLimiter

interface RateLimiter

An interface for rate limiters.

RateLimitName

@JvmInline

value class RateLimitName(name: String)

A name of registered RateLimit provider.

RateLimitProviderConfig

class RateLimitProviderConfig(name: RateLimitName)

A config for RateLimit provider inside RateLimiterConfig.

RateLimitRouteSelector

class RateLimitRouteSelector(val name: RateLimitName) : RouteSelector

A rate-limited route node that is used by the RateLimit plugin and usually created by the Route.rateLimit DSL function, so generally there is no need to instantiate it directly unless you are writing an extension.

Properties

RateLimit

val RateLimit: ApplicationPlugin<RateLimitConfig>

A plugin that provides rate limiting for incoming requests.

Functions

rateLimit

fun Route.rateLimit(configuration: RateLimitName = LIMITER_NAME_EMPTY, build: Route.() -> Unit): Route

Creates a route with Rate-Limit rules applied to it. This function accepts name of RateLimit providers defined in the RateLimit plugin configuration.