GenLoop v1.0.0 GenLoop behaviour
Link to this section Summary
Types
Debug options supported by the start*
functions
Tuple describing the client of a call request.
pid
is the PID of the caller and tag
is a unique term used to identify the
call.
The GenLoop name
Return values of start*
functions
Option values used by the start*
functions
Options used by the start*
functions
The server reference
Functions
Behaves just like Kernel.send but accepts atoms or registry tuples on top of pids to identify a process.
Link to this section Types
debug()
debug() :: [:trace | :log | :statistics | {:log_to_file, Path.t()}]
debug() :: [:trace | :log | :statistics | {:log_to_file, Path.t()}]
Debug options supported by the start*
functions
from()
Tuple describing the client of a call request.
pid
is the PID of the caller and tag
is a unique term used to identify the
call.
name()
The GenLoop name
on_start()
Return values of start*
functions
option()
option() ::
{:debug, debug()}
| {:name, name()}
| {:timeout, timeout()}
| {:spawn_opt, Process.spawn_opt()}
option() :: {:debug, debug()} | {:name, name()} | {:timeout, timeout()} | {:spawn_opt, Process.spawn_opt()}
Option values used by the start*
functions
options()
options() :: [option()]
options() :: [option()]
Options used by the start*
functions
server()
The server reference
Link to this section Functions
abcast(server, term)
See GenServer.abcast/2
.
abcast(nodes, server, term)
See GenServer.abcast/3
.
call(server, request, timeout \\ 5000)
cast(server, term)
See GenServer.cast/2
.
from_pid(from) (macro)
hibernate(module, function, args) (macro)
multi_call(nodes \\ [node() | Node.list()], name, request, timeout \\ :infinity)
rcall(from, msg) (macro)
rcast(msg) (macro)
receive(state_var, blocks) (macro)
reply(from, term)
See GenServer.reply/2
.
send(server, message)
Behaves just like Kernel.send but accepts atoms or registry tuples on top of pids to identify a process.
start(module, args, options \\ [])
start_link(module, args, options \\ [])
stop(server)
See GenServer.stop/1
.
stop(server, reason)
See GenServer.stop/2
.
stop(server, reason, timeout)
See GenServer.stop/3
.
whereis(name)
See GenServer.whereis/1
.
Link to this section Callbacks
code_change(old_vsn, state, extra)
data_vsn()
data_vsn() :: term()
data_vsn() :: term()