Pristine.Ports.RateLimit behaviour (Pristine v0.4.0)

Rate limit boundary.

Summary

clear(term)

Clear any stored limiter state.

Resolve a limiter for a key.

Set a limiter backoff window in milliseconds.

Block until the limiter allows the operation.

(optional)

@callback clear(term()) :: :ok

Clear any stored limiter state.

(optional)

@callback for_key(term(), keyword()) :: term()

Resolve a limiter for a key.

(optional)

@callback set(term(), non_neg_integer(), keyword()) :: :ok

Set a limiter backoff window in milliseconds.

(optional)

@callback wait(term(), keyword()) :: :ok

Block until the limiter allows the operation.

@callback within_limit((-> term()), keyword()) :: term()