View Source opuntia_srv (opuntia v1.1.0)

Shared shapers.

Summary

Types

args/0
gen_shape/0
This accepts a function that generates the shape, if such shape was too expensive to calculate. Note that for this server, only full buckets and in milliseconds are valid, due to the nature of gen_server call timeouts.
key/0
name/0
opuntia_state/0
seconds/0
shape/0

Functions

request_wait(Shaper, Key, Tokens, Config)

Shapes the caller from executing the action, asynchronously

reset_shapers(ProcName)
Ask server to forget all its shapers
start_link(Name, Args)
Start-links a shaper server
wait(Shaper, Key, Tokens, Config)

Shapes the caller from executing the action

Types

Link to this type

args/0

View Source 
-type args() :: #{max_delay => opuntia:delay(), cleanup_interval => seconds(), ttl => seconds()}.
Link to this type

gen_shape/0

View Source 
-type gen_shape() :: fun(() -> shape()) | shape().
This accepts a function that generates the shape, if such shape was too expensive to calculate. Note that for this server, only full buckets and in milliseconds are valid, due to the nature of gen_server call timeouts.
Link to this type

key/0

View Source 
-type key() :: term().
Link to this type

name/0

View Source 
-type name() :: atom().
Link to this type

opuntia_state/0

View Source 
-type opuntia_state() :: #opuntia_state{}.
Link to this type

seconds/0

View Source 
-type seconds() :: non_neg_integer().
Link to this type

shape/0

View Source 
-type shape() ::
    0 |
    #{bucket_size := opuntia:bucket_size(),
      rate := opuntia:rate(),
      time_unit := millisecond,
      start_full := true}.

Functions

Link to this function

request_wait(Shaper, Key, Tokens, Config)

View Source 
-spec request_wait(gen_server:server_ref(), key(), opuntia:tokens(), gen_shape()) ->
                gen_server:request_id().

Shapes the caller from executing the action, asynchronously

This will do a gen_server:send_request/2. Usual pattern applies to receive the matching continue.
Link to this function

reset_shapers(ProcName)

View Source
Ask server to forget all its shapers
Link to this function

start_link(Name, Args)

View Source 
-spec start_link(name(), args()) -> ignore | {error, _} | {ok, pid()}.
Start-links a shaper server
Link to this function

wait(Shaper, Key, Tokens, Config)

View Source 
-spec wait(gen_server:server_ref(), key(), opuntia:tokens(), gen_shape()) ->
        continue | {error, max_delay_reached}.

Shapes the caller from executing the action

This will do an actual blocking gen_server:call/3.