bucket4j/wisp.ratelimiting.bucket4j/Bucket4jRateLimiter

Bucket4jRateLimiter

class Bucket4jRateLimiter @JvmOverloads constructor(bucketProxy: ProxyManager<String>, clock: Clock, meterRegistry: MeterRegistry = Metrics.globalRegistry) : RateLimiter

Constructors

Bucket4jRateLimiter

@JvmOverloads

constructor(bucketProxy: ProxyManager<String>, clock: Clock, meterRegistry: MeterRegistry = Metrics.globalRegistry)

Functions

availableTokens

open override fun availableTokens(key: String, configuration: RateLimitConfiguration): Long

consumeToken

open override fun consumeToken(key: String, configuration: RateLimitConfiguration, amount: Long): RateLimiter.ConsumptionData

releaseToken

open override fun releaseToken(key: String, configuration: RateLimitConfiguration, amount: Long)

resetBucket

open override fun resetBucket(key: String, configuration: RateLimitConfiguration)

testConsumptionAttempt

open override fun testConsumptionAttempt(key: String, configuration: RateLimitConfiguration, amount: Long): RateLimiter.TestConsumptionResult

withToken

open fun <T> withToken(key: String, configuration: RateLimitConfiguration, f: () -> T): RateLimiter.ExecutionResult<T>