Module e2_supervisor

Description
Function Index
Function Details

e2 supervisor.

Authors: Garrett Smith ([email protected]).

Description

e2 supervisor.

An e2 supervisor provides identical functionality to that of an OTP supervisor but uses a simpler interface.

See e2 supervisor documentation for more information.

Function Index

start_child/2	Adds a child spec to a supervisor and starts the child process.
start_link/2	Starts a linked e2 supervisor.
start_link/3	Starts a linked e2 supervisor.
supervisor_spec/2	Returns an OTP supervisor spec for a list of child specs and e2 supervisor options.

Function Details

start_child/2

start_child(Sup::Supervisor, Args::ChildSpecOrArgs) -> Result

Supervisor = pid() | atom()
ChildSpecOrArgs = ChildSpec | [term()]
ChildSpec = {{Module, Function, Args}, ChildOptions} | {Module, Function, Args} | {Module, ChildOptions} | Module
Result = {ok, Child} | {error, Error}
Child = pid()
Error = already_present | {already_started, Child} | term()

Adds a child spec to a supervisor and starts the child process.

start_link/2

start_link(Module, ChildrenOrArgs) -> any()

Equivalent to start_link(Module, ChildrenOrArgs, []).

Starts a linked e2 supervisor.

start_link/3

start_link(Module, ChildrenOrArgs, Options) -> {ok, Pid} | {error, Reason}

Module = module()
ChildrenOrArgs = Children | term()
Children = [ChildSpec]
ChildSpec = {{Module, Function, Args}, ChildOptions} | {Module, Function, Args} | {Module, ChildOptions} | Module
Module = atom()
Function = atom()
Args = [term()]
ChildOptions = [ChildOption]
ChildOption = {id, term()} | {restart, Restart} | {shutdown, Shutdown}
Restart = permanent | temporary | transient
Shutdown = brutal_kill | integer()
Options = [Option]
Option = {strategy, Strategy} | {max_restart, {Max, Seconds}} | Registered
Strategy = one_for_all | one_for_one | rest_for_one | simple_one_for_one
Max = integer()
Seconds = integer()
Registered = registered | {registered, Name}
Name = atom()

Starts a linked e2 supervisor.

The e2 supervisor API lets you create child specs with minimal complexity, picking sensible defaults for missing values.

If Module exports init/1, ChildrenOrArgs will be used as the argument to that function and the result of that function will be used as the child spec.

Defaults

  Function = start_link
  Args = []
  ChildOptions = [{id, Module}, {restart, permanent}, {shutdown, brutal_kill}]
  Options = [{strategy, one_for_one}, {max_restart, {1, 1}}]

Refer to e2 supervisor and e2 applications documentation for more information.

supervisor_spec/2

supervisor_spec(Children, Options) -> OTPSupervisorSpec

Returns an OTP supervisor spec for a list of child specs and e2 supervisor options.

See start_link/3 for details on ChildSpec and Options.

Generated by EDoc