Module ocs_sup

This supervisor behaviour callback module implements a supervisor in the ocs application.

Copyright © 2016 - 2026 SigScale Global Inc.

Behaviours: supervisor.

Description

This supervisor behaviour callback module implements a supervisor in the ocs application.

The supervision heirachy is depicted in Figure 1-1 as a directed graph starting from the top. The supervisor behaviour nodes are depicted as blue boxes while gen_server and gen_fsm behaviours are depicted as yellow and green ovals respectively. The edge (line) between nodes is labeled with the number of identical nodes which may exist (N indicates any number). The node label for child workers indicates when they will be restarted (permanent, temporary or transient). Node labels provide the name of the callback module implementing the behaviour. For supervisors the sup_flags() are also provided as {RestartStrategy::strategy(), Intensity::integer(), Period::integer()}.

supervision heirachy
Figure 1-1

Function Index

init/1Initialize the ocs_sup supervisor.
supervisor/2*Build a supervisor child specification for a supervisor behaviour.
supervisor/3*Build a supervisor child specification for a supervisor behaviour with registered name.
server/2*Build a supervisor child specification for a gen_server behaviour.
event/1*Build a supervisor child specification for a gen_event behaviour.

Function Details

init/1

init(Args) -> Result

Initialize the ocs_sup supervisor.

See also: //stdlib/supervisor:init/1.

supervisor/2 *

supervisor(StartMod, Args) -> Result

Build a supervisor child specification for a supervisor behaviour.

supervisor/3 *

supervisor(StartMod, RegName, Args) -> Result

Build a supervisor child specification for a supervisor behaviour with registered name.

server/2 *

server(StartMod, Args) -> Result

Build a supervisor child specification for a gen_server behaviour.

event/1 *

event(StartMod) -> Result

Build a supervisor child specification for a gen_event behaviour.


Generated by EDoc