Module supervisor_pre_r14b04

Data Types
Function Index
Function Details

Behaviours: gen_server.

This module defines the supervisor_pre_r14b04 behaviour.
Required callback functions: init/1.

Data Types

call()

call() = which_children | count_children | {term(), term()}

XXX: refine

child_rec()

child_rec() = #child{pid = child() | [pid()], name = any(), mfargs = mfargs(), restart_type = restart(), shutdown = shutdown(), child_type = worker(), modules = modules()}

child_spec()

child_spec() = {Id::child_id(), StartFunc::mfargs(), Restart::restart(), Shutdown::shutdown(), Type::worker(), Modules::modules()}

mfargs()

mfargs() = {M::module(), F::atom(), A::[term()] | undefined}

restart()

restart() = permanent | transient | temporary

startchild_err()

startchild_err() = already_present | {already_started, Child::child()} | term()

startchild_ret()

startchild_ret() = {ok, Child::child()} | {ok, Child::child(), Info::term()} | {error, startchild_err()}

startlink_err()

startlink_err() = {already_started, pid()} | shutdown | term()

startlink_ret()

startlink_ret() = {ok, pid()} | ignore | {error, startlink_err()}

state() = #state{name = any(), strategy = strategy(), children = [child_rec()], dynamics = riak_core_dict() | riak_core_set(), intensity = non_neg_integer(), period = pos_integer(), restarts = any(), module = any(), args = any()}

stop_rsn()

stop_rsn() = shutdown | {bad_return, {module(), init, term()}} | {bad_start_spec, term()} | {start_spec, term()} | {supervisor_data, term()}

strategy()

strategy() = one_for_all | one_for_one | rest_for_one | simple_one_for_one

sup_name()

sup_name() = {local, Name::atom()} | {global, Name::atom()}

sup_ref()

sup_ref() = (Name::atom()) | {Name::atom(), Node::node()} | {global, Name::atom()} | pid()

worker()

worker() = worker | supervisor

Function Index

behaviour_info/1
check_childspecs/1
code_change/3
count_children/1
delete_child/2
handle_call/3
handle_cast/2
handle_info/2
init/1
restart_child/2
start_child/2
start_link/2
start_link/3
terminate/2
terminate_child/2
which_children/1

Function Details

behaviour_info/1

behaviour_info(Other::atom()) -> undefined | [{atom(), arity()}]

check_childspecs/1

check_childspecs(ChildSpecs) -> Result

ChildSpecs = [child_spec()]
Result = ok | {error, Error::term()}

code_change/3

code_change(X1::term(), State::state(), X3::term()) -> {ok, state()} | {error, term()}

count_children/1

count_children(SupRef) -> PropListOfCounts

SupRef = sup_ref()
PropListOfCounts = [Count]
Count = {specs, ChildSpecCount::non_neg_integer()} | {active, ActiveProcessCount::non_neg_integer()} | {supervisors, ChildSupervisorCount::non_neg_integer()} | {workers, ChildWorkerCount::non_neg_integer()}

delete_child/2

delete_child(SupRef, Id) -> Result

SupRef = sup_ref()
Id = child_id()
Result = ok | {error, Error}
Error = running | not_found | simple_one_for_one

handle_call/3

handle_call(X1::call(), From::term(), State::state()) -> {reply, term(), state()}

handle_cast/2

handle_cast(X1::null, State::state()) -> {noreply, state()}

handle_info/2

handle_info(Msg::term(), State::state()) -> {noreply, state()} | {stop, shutdown, state()}

init/1

init(X1::{init_sup_name(), module(), [term()]}) -> {ok, state()} | ignore | {stop, stop_rsn()}

restart_child/2

restart_child(SupRef, Id) -> Result

SupRef = sup_ref()
Id = child_id()
Result = {ok, Child::child()} | {ok, Child::child(), Info::term()} | {error, Error}
Error = running | not_found | simple_one_for_one | term()

start_child/2

start_child(SupRef, ChildSpec) -> startchild_ret()

SupRef = sup_ref()
ChildSpec = child_spec() | (List::[term()])

start_link/2

start_link(Module, Args) -> startlink_ret()

Module = module()
Args = term()

start_link/3

start_link(SupName, Module, Args) -> startlink_ret()

SupName = sup_name()
Module = module()
Args = term()

terminate/2

terminate(Reason::term(), State::state()) -> ok

terminate_child/2

terminate_child(SupRef, Id) -> Result

SupRef = sup_ref()
Id = pid() | child_id()
Result = ok | {error, Error}
Error = not_found | simple_one_for_one

which_children/1

which_children(SupRef) -> [{Id, Child, Type, Modules}]

SupRef = sup_ref()
Id = child_id() | undefined
Child = child()
Type = worker()
Modules = modules()

Generated by EDoc