kresil-lib/kresil.ratelimiter.config/RateLimiterConfigBuilder

RateLimiterConfigBuilder

class RateLimiterConfigBuilder(val baseConfig: RateLimiterConfig = defaultRateLimiterConfig) : ConfigBuilder<RateLimiterConfig> (source)

Builder for configuring a RateLimiterConfig instance. Use rateLimiterConfig to create one.

Constructors

constructor(baseConfig: RateLimiterConfig = defaultRateLimiterConfig)

Types

Companion

private object Companion

Properties

algorithm

private var algorithm: RateLimitingAlgorithm

baseConfig

open override val baseConfig: RateLimiterConfig

The base configuration object to be used as a starting point for building the final configuration object.

baseTimeoutDuration

var baseTimeoutDuration: Duration

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.

onRejected

private var onRejected: ExceptionHandler

Functions

algorithm

fun algorithm(algorithm: RateLimitingAlgorithm)

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

build

open override fun build(): RateLimiterConfig

Builds the final configuration object after applying possible modifications to the base configuration.

checkAlgorithmConfig

private fun checkAlgorithmConfig(algorithm: RateLimitingAlgorithm)

onRejected

fun onRejected(block: ExceptionHandler)

Configures the exception handler that will be called when a request is rejected by the rate limiter. By default, the exception handler will the caught exception.