ktor-server-plugins/kresil.ktor.server.plugins.ratelimiter.config/RateLimiterPluginConfigBuilder

RateLimiterPluginConfigBuilder

class RateLimiterPluginConfigBuilder(val baseConfig: RateLimiterPluginConfig)(source)

Builder for configuring the KresilRateLimiterPlugin.

Constructors

constructor(baseConfig: RateLimiterPluginConfig)

Properties

baseConfig

open val baseConfig: RateLimiterPluginConfig

baseTimeoutDuration

var baseTimeoutDuration: <Error class: unknown class>

Configures the default duration a request will be placed in the queue if the request is rate-limited. After this duration, the request will be rejected. Should be non-negative.

callWeight

private var callWeight: CallWeight

excludeFromRateLimiting

private var excludeFromRateLimiting: ExcludePredicate

interceptPhase

private var interceptPhase: <Error class: unknown class><suspend (<Error class: unknown class>) -> Unit>

keyResolver

private var keyResolver: KeyResolver

onRejectedCall

private var onRejectedCall: OnRejectedCall

onSuccessCall

private var onSuccessCall: OnSuccessCall

rateLimiterConfig

private val rateLimiterConfig: <Error class: unknown class>

rateLimiterConfigBuilder

private val rateLimiterConfigBuilder: <Error class: unknown class>

Functions

algorithm

fun algorithm(algorithm: <Error class: unknown class>)

Sets the rate limiting algorithm. See RateLimitingAlgorithm for more details.

build

open fun build(): RateLimiterPluginConfig

callWeight

fun callWeight(callWeight: CallWeight)

Sets the weight of a call for rate limiting purposes. The weight is used to determine how many permits a call consumes.

excludeFromRateLimiting

fun excludeFromRateLimiting(excludePredicate: ExcludePredicate)

Sets the function to determine if a request should be excluded from rate limiting.

interceptPhase

fun interceptPhase(interceptPhase: <Error class: unknown class><suspend (<Error class: unknown class>) -> Unit>)

Sets the phase in the application pipeline where rate limiting is applied.

keyResolver

fun keyResolver(keyResolver: KeyResolver)

Sets the function to resolve the key for rate limiting from the application call.

onRejectedCall

fun onRejectedCall(onRejectedCall: OnRejectedCall)

Sets the callback to handle requests that are rejected due to rate limiting.

onSuccessCall

fun onSuccessCall(onSuccessCall: OnSuccessCall)

Sets the callback to handle successful requests.