ex_waiter v1.3.1

ExWaiter.RateLimiting (ex_waiter v1.3.1) View Source

Link to this section Summary

Types

bucket()
options()
token_count()
unix_timestamp_in_ms()

Functions

limit_rate(bucket, opts \\ [])

Link to this section Types

Link to this type

bucket()

View Source

Specs

bucket() :: {token_count(), unix_timestamp_in_ms()}
Link to this type

options()

View Source

Specs

options() :: [
  refill_rate: pos_integer(),
  interval: pos_integer(),
  burst_limit: pos_integer(),
  cost: pos_integer()
]
Link to this type

token_count()

View Source

Specs

token_count() :: non_neg_integer()
Link to this type

unix_timestamp_in_ms()

View Source

Specs

unix_timestamp_in_ms() :: pos_integer()

Link to this section Functions

Link to this function

limit_rate(bucket, opts \\ [])

View Source

Specs

limit_rate(bucket() | nil, options()) ::
  {:ok, bucket(), ExWaiter.RateLimiting.Limiter.t()}
  | {:error, bucket(), ExWaiter.RateLimiting.Limiter.t()}