Arrow Resilience Kit/com.sorinirmies.arrow.resiliencekit/DistributedRateLimiter

DistributedRateLimiter

class DistributedRateLimiter(store: SharedStateStore, key: String, maxRequests: Int, window: Duration, clock: Clock = Clock.System)(source)

Cross-instance fixed-window rate limiter whose counter lives in a SharedStateStore (e.g. a Redis-backed one), so every process sharing the store shares one budget of maxRequests per window.

val limiter = DistributedRateLimiter(redisStore, "api", maxRequests = 100, window = 1.minutes)
limiter.execute { callApi() }   // throws RateLimitExceededException when over budget

Constructors

constructor(store: SharedStateStore, key: String, maxRequests: Int, window: Duration, clock: Clock = Clock.System)

Functions

asPolicy

fun asPolicy(): Policy

Adapts this limiter into a Policy.

execute

suspend fun <T> execute(block: suspend () -> T): T

Runs block if a permit is available.

tryAcquire

suspend fun tryAcquire(): Boolean

Tries to take one permit. Returns true if granted.

tryExecute

suspend fun <T> tryExecute(block: suspend () -> T): T?

Like execute but returns null when over budget.