Module gen_errand

This module defines the gen_errand behaviour.
Required callback functions: init/1, sleep_time/2, handle_execute/1, handle_event/4.
Optional callback functions: terminate/3, code_change/4.

Data Types

errand_state()

from()

call(ServerRef, Message) -> Reply

ServerRef = server_ref()
Message = term()
Reply = term()

call/3

call(ServerRef, Message, Timeout) -> Reply

ServerRef = server_ref()
Message = term()
Timeout = timeout()
Reply = term()

cast/2

cast(ServerRef, Message) -> ok

ServerRef = server_ref()
Message = term()

cooldown/5

cooldown(Attempt, Delay, Backoff, Growth, Jitter) -> Time

Attempt = non_neg_integer()
Delay = integer()
Backoff = number()
Growth = number()
Jitter = number()
Time = non_neg_integer()

reply/2

reply(From, Message) -> ok

From = from()
Message = term()

start/3

start(Module, Args, Opts) -> Result

Module = module()
Args = term()
Opts = [start_opt()]
Result = start_ret()

start/4

start(ServerName, Module, Args, Opts) -> Result

ServerName = server_name()
Module = module()
Args = term()
Opts = [start_opt()]
Result = start_ret()

start_link/3

start_link(Module, Args, Opts) -> Result

Module = module()
Args = term()
Opts = [start_opt()]
Result = start_ret()

start_link/4

start_link(ServerName, Module, Args, Opts) -> Result

ServerName = server_name()
Module = module()
Args = term()
Opts = [start_opt()]
Result = start_ret()

start_monitor/3

start_monitor(Module, Args, Opts) -> Result

Module = module()
Args = term()
Opts = [start_opt()]
Result = start_mon_ret()

start_monitor/4

start_monitor(ServerName, Module, Args, Opts) -> Result

ServerName = server_name()
Module = module()
Args = term()
Opts = [start_opt()]
Result = start_mon_ret()

stop/1

stop(ServerRef) -> ok

ServerRef = server_ref()

stop/3

stop(ServerRef, Reason, Timeout) -> ok

ServerRef = server_ref()
Reason = term()
Timeout = timeout()

wait/2

wait(ServerRef, State) -> ok

ServerRef = server_ref()
State = errand_state()

wait/3

wait(ServerRef, State, Timeout) -> ok

ServerRef = server_ref()
State = errand_state()
Timeout = timeout()