-spec change_rate(name(), rate(), interval()) -> ok | {error, any()}.

Sets Rate and Interval for Name according to the given values.

-spec change_rate_gradually(name(), rate(), rate(), interval(), pos_integer(), pos_integer()) ->
                         ok | {error, any()}.

Allows to set a plan of gradual rate changes for a given Name.

Rate will be changed from FromRate to ToRate in a series of consecutive steps. Note that FromRate does not need to be lower than ToRate, rates can be changed downwards.

The rate is calculated at each step in relation to the RateInterval, which can also be 0. There will be NoOfSteps steps, each taking StepInterval time in milliseconds.

-spec pause(name()) -> ok | {error, any()}.

Pauses executions for the given Name as if Rate was set to 0.

-spec run(name(), fun(() -> any())) -> ok | {error, any()}.

Executes a given function Fn when it does not exceed the rate for Name.

Fn is executed in the context of a new process spawned on the same node on which the process executing run/2 runs, so a call to run/2 is non-blocking. This function is used internally by both send and send_and_wait/2 functions, so all those actions will be limited to the same rate when called with the same Name.

         title Amoc distributed
         participantgroup  **Slave node**
             participant User
             participant Async runner
         end
         participantgroup **Master node**
             participant Throttle process
         end
         box left of User: inc req rate
 
         User -> *Async runner : Fun
 
         User -> Throttle process : {schedule, Async runner PID}
         box right of Throttle process : inc req rate
 
         ==throtlling delay==
 
         Throttle process -> Async runner: scheduled
 
         box left of Async runner : inc exec rate
         abox over Async runner : Fun()
         activate Async runner
         box right of Throttle process : inc exec rate
         deactivate Async runner
         Async runner ->Throttle process:'DOWN'
         destroy Async runner

-spec send(name(), any()) -> ok | {error, any()}.

See also: send/3.

-spec send(name(), pid(), any()) -> ok | {error, any()}.

Sends a given message Msg to a given Pid when the rate for Name allows for that.

-spec send_and_wait(name(), any()) -> ok | {error, any()}.

Sends and receives the given message Msg.

-spec start(name(), rate()) -> ok | {error, any()}.

See also: start/4.

-spec start(name(), rate(), non_neg_integer()) -> ok | {error, any()}.

See also: start/4.

-spec start(name(), rate(), interval(), pos_integer()) -> ok | {error, any()}.

Starts the throttle mechanism for a given Name with a given Rate per Interval.