krate-core/com.neutrine.krate/RateLimiterBuilder

RateLimiterBuilder

class RateLimiterBuilder(maxRate: Long)

A builder for RateLimiter instances.

Parameters

maxRate

the maximum rate at which tokens can be consumed

Constructors

RateLimiterBuilder

constructor(maxRate: Long)

Properties

var clock: Clock

The clock to use to get the current time. Defaults to the system clock.

var maxBurst: Long

The maximum number of tokens that can be stored in the bucket. Defaults to maxRate.

maxRateTimeUnit

var maxRateTimeUnit: TemporalUnit

The TemporalUnit of the maxRate. Defaults to ChronoUnit.SECONDS.

var stateStorage: StateStorage

The state storage to use to store the bucket state.

Functions

fun build(): RateLimiter