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

SlidingWindowRateLimiter

Sliding window rate limiter implementation.

Unlike token bucket, this tracks requests within a time window and rejects requests if the limit is exceeded within that window.

Use Cases:

Strict rate limiting (e.g., "max 100 requests per minute")
Time-based quotas
More predictable rate limiting than token bucket

Parameters

config

Configuration for sliding window rate limiter

Example usage:

val rateLimiter = SlidingWindowRateLimiter.create(
    config = SlidingWindowConfig(
        maxRequests = 100,
        windowDuration = 1.minutes
    )
)

Types

Companion

object Companion

Factory for SlidingWindowRateLimiter.

Functions

currentRequests

suspend fun currentRequests(): Int

Gets the current number of requests in the window.

execute

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

Executes an operation with sliding window rate limiting.

reset

suspend fun reset()

Resets the rate limiter to initial state.

statistics

suspend fun statistics(): SlidingWindowStatistics

Gets the current statistics.

tryAcquire

suspend fun tryAcquire(): Boolean

Tries to acquire a permit within the sliding window.

tryExecute

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

Tries to execute an operation, returning null if rate limited.

Inherited functions

asPolicy

fun SlidingWindowRateLimiter.asPolicy(): Policy

Adapts this SlidingWindowRateLimiter into a Policy.