kord-common/dev.kord.common.ratelimit

Package-level declarations

Types

abstract class AbstractIntervalRateLimiter(val limit: Int, val interval: Duration) : IntervalRateLimiter

Abstract base class for implementing IntervalRateLimiter.

interface IntervalRateLimiter : RateLimiter

A RateLimiter that restricts the number of consume invocations in intervals to a given limit. Exceeding this limit results in suspension until the next interval.

RateLimiter

interface RateLimiter

A rate limiter that limits the number of consume invocations that can be made over a certain period.

Functions

consume

inline suspend fun <T> RateLimiter.consume(action: () -> T): T

Acquires a permit for a single action. Suspends if necessary until the permit would not exceed the maximum frequency of permits.

IntervalRateLimiter

fun IntervalRateLimiter(limit: Int, interval: Duration, timeSource: TimeSource = TimeSource.Monotonic): IntervalRateLimiter

Creates an implementation of IntervalRateLimiter that uses a TimeSource for measuring intervals.

fun IntervalRateLimiter(limit: Int, interval: Duration, clock: Clock): IntervalRateLimiter

Creates an implementation of IntervalRateLimiter that uses a Clock for measuring intervals.