Nostrum.Api.Ratelimiter (Nostrum v0.4.6) View Source

Ratelimit implimentation specific to Discord's API. Only to be used when starting in a rest-only manner.

Link to this section Summary

Return values of start functions.

Returns a specification to start this module under a supervisor.

Empties all buckets, voiding any saved ratelimit values.

Retrieves a proper ratelimit endpoint from a given route and url.

Callback implementation for GenServer.init/1.

Starts the ratelimiter.

on_start() ::
  {:ok, pid()} | :ignore | {:error, {:already_started, pid()} | term()}

Return values of start functions.

Returns a specification to start this module under a supervisor.

empty_buckets() :: true

Empties all buckets, voiding any saved ratelimit values.

get_endpoint(String.t(), atom()) :: String.t()

Retrieves a proper ratelimit endpoint from a given route and url.

Callback implementation for GenServer.init/1.

start_link([]) :: on_start()

Starts the ratelimiter.