class RateLimiter::Limiter

• RateLimiter::Limiter
• Reference
• Object

Overview

A rate limiter erogating tokens at the specified rate.

This is powered by the token bucket algorithm.

Included Modules

• RateLimiter::LimiterLike

Defined in:

rate_limiter.cr

Constructors

• .new(rate : Float64, max_burst : Int32 = 1)

Instance Method Summary

• #bucket : Channel(Nil)
• #get(max_wait : Time::Span) : Token | Timeout

  Returns a Token if one is available within max_wait time, otherwise it returns a Timeout.

• #get : Token

  Returns a Token as soon as available.

• #rate : Float64

Constructor Detail

Instance Method Detail