brod v3.18.0

View Source brod_supervisor3 behaviour (brod v3.18.0)

Link to this section Summary

Types

call/0
XXX: refine
child/0
child_id/0
child_rec/0
child_spec/0
delay/0
dynamics/0
init_sup_name/0
mfargs/0
modules/0
restart/0
shutdown/0
startchild_err/0
startchild_ret/0
startlink_err/0
startlink_ret/0
state/0
stop_rsn/0
strategy/0
sup_name/0
sup_ref/0
tref/0
worker/0

Callbacks

init/1
post_init/1

Functions

check_childspecs(ChildSpecs)
code_change(_, State, _)
count_children(SupRef)
delete_child(SupRef, Id)
find_child(Supervisor, Name)
format_status(_, _)
handle_call(_, From, State)
handle_cast(_, State)
handle_info(Msg, State)
init(_)
restart_child(SupRef, Id)
start_child(SupRef, ChildSpec)
start_link(Module, Args)
start_link(SupName, Module, Args)
terminate(Reason, State)
terminate_child(SupRef, Id)
try_again_restart(SupRef, Child, Reason)
which_children(SupRef)

Link to this section Types

Link to this type

call/0

View Source 
-type call() :: which_children | count_children | {_, _}.
XXX: refine
Link to this type

child/0

View Source 
-type child() :: undefined | pid().
Link to this type

child_id/0

View Source 
-type child_id() :: term().
Link to this type

child_rec/0

View Source 
-type child_rec() :: #child{}.
Link to this type

child_spec/0

View Source 
-type child_spec() ::
    {Id :: child_id(),
     StartFunc :: mfargs(),
     Restart :: restart(),
     Shutdown :: shutdown(),
     Type :: worker(),
     Modules :: modules()}.
Link to this type

delay/0

View Source 
-type delay() :: non_neg_integer().
Link to this type

dynamics/0

View Source 
-type dynamics() :: dict:dict() | sets:set().
Link to this type

init_sup_name/0

View Source 
-type init_sup_name() :: sup_name() | self.
Link to this type

mfargs/0

View Source 
-type mfargs() :: {M :: module(), F :: atom(), A :: [term()] | undefined}.
Link to this type

modules/0

View Source 
-type modules() :: [module()] | dynamic.
Link to this type

restart/0

View Source 
-type restart() ::
    permanent | transient | temporary | intrinsic |
    {permanent, delay()} |
    {transient, delay()} |
    {intrinsic, delay()}.
Link to this type

shutdown/0

View Source 
-type shutdown() :: brutal_kill | timeout().
Link to this type

startchild_err/0

View Source 
-type startchild_err() :: already_present | {already_started, Child :: child()} | term().
Link to this type

startchild_ret/0

View Source 
-type startchild_ret() ::
    {ok, Child :: child()} | {ok, Child :: child(), Info :: term()} | {error, startchild_err()}.
Link to this type

state/0

View Source 
-type state() ::
    #state{name :: atom(),
           strategy :: strategy(),
           children :: [child_rec()],
           dynamics :: dynamics(),
           intensity :: non_neg_integer(),
           period :: pos_integer(),
           restarts :: list(),
           module :: module(),
           args :: list()}.
Link to this type

stop_rsn/0

View Source 
-type stop_rsn() ::
    {shutdown, term()} |
    {bad_return, {module(), init, term()}} |
    {bad_start_spec, term()} |
    {start_spec, term()} |
    {supervisor_data, term()}.
Link to this type

strategy/0

View Source 
-type strategy() :: one_for_all | one_for_one | rest_for_one | simple_one_for_one.
Link to this type

sup_name/0

View Source 
-type sup_name() :: {local, Name :: atom()} | {global, Name :: atom()}.
Link to this type

sup_ref/0

View Source 
-type sup_ref() ::
    (Name :: atom()) | {Name :: atom(), Node :: node()} | {global, Name :: atom()} | pid().
Link to this type

tref/0

View Source 
-type tref() :: reference().
Link to this type

worker/0

View Source 
-type worker() :: worker | supervisor.

Link to this section Callbacks

Link to this callback

init/1

View Source 
-callback init(Args :: term()) ->
        {ok,
         {{RestartStrategy :: strategy(), MaxR :: non_neg_integer(), MaxT :: non_neg_integer()},
          [ChildSpec :: child_spec()]}} |
        ignore | post_init.
Link to this callback

post_init/1

View Source (optional) 
-callback post_init(Args :: term()) ->
             {ok,
              {{RestartStrategy :: strategy(),
                MaxR :: non_neg_integer(),
                MaxT :: non_neg_integer()},
               [ChildSpec :: child_spec()]}} |
             ignore.

Link to this section Functions

Link to this function

check_childspecs(ChildSpecs)

View Source 
-spec check_childspecs(ChildSpecs) -> Result
                    when ChildSpecs :: [child_spec()], Result :: ok | {error, Error :: term()}.
Link to this function

code_change(_, State, _)

View Source 
-spec code_change(term(), state(), term()) -> {ok, state()} | {error, term()}.
Link to this function

count_children(SupRef)

View Source 
-spec count_children(SupRef) -> PropListOfCounts
                  when
                      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()}.
Link to this function

delete_child(SupRef, Id)

View Source 
-spec delete_child(SupRef, Id) -> Result
                when
                    SupRef :: sup_ref(),
                    Id :: child_id(),
                    Result :: ok | {error, Error},
                    Error :: running | restarting | not_found | simple_one_for_one.
Link to this function

find_child(Supervisor, Name)

View Source 
-spec find_child(Supervisor, Name) -> [pid()] when Supervisor :: sup_ref(), Name :: child_id().
Link to this function

format_status(_, _)

View Source
Link to this function

handle_call(_, From, State)

View Source 
-spec handle_call(call(), term(), state()) -> {reply, term(), state()}.
Link to this function

handle_cast(_, State)

View Source 
-spec handle_cast({try_again_restart, child_id() | pid(), term()}, state()) ->
               {noreply, state()} | {stop, shutdown, state()}.
Link to this function

handle_info(Msg, State)

View Source 
-spec handle_info(term(), state()) -> {noreply, state()} | {stop, term(), state()}.
Link to this function

init(_)

View Source 
-spec init({init_sup_name(), module(), [term()]}) -> {ok, state()} | ignore | {stop, stop_rsn()}.
Link to this function

restart_child(SupRef, Id)

View Source 
-spec restart_child(SupRef, Id) -> Result
                 when
                     SupRef :: sup_ref(),
                     Id :: child_id(),
                     Result ::
                         {ok, Child :: child()} |
                         {ok, Child :: child(), Info :: term()} |
                         {error, Error},
                     Error :: running | restarting | not_found | simple_one_for_one | term().
Link to this function

start_child(SupRef, ChildSpec)

View Source 
-spec start_child(SupRef, ChildSpec) -> startchild_ret()
               when SupRef :: sup_ref(), ChildSpec :: child_spec() | (List :: [term()]).
Link to this function

start_link(Module, Args)

View Source 
-spec start_link(Module, Args) -> startlink_ret() when Module :: module(), Args :: term().
Link to this function

start_link(SupName, Module, Args)

View Source 
-spec start_link(SupName, Module, Args) -> startlink_ret()
              when SupName :: sup_name(), Module :: module(), Args :: term().
Link to this function

terminate(Reason, State)

View Source 
-spec terminate(term(), state()) -> ok.
Link to this function

terminate_child(SupRef, Id)

View Source 
-spec terminate_child(SupRef, Id) -> Result
                   when
                       SupRef :: sup_ref(),
                       Id :: pid() | child_id(),
                       Result :: ok | {error, Error},
                       Error :: not_found | simple_one_for_one.
Link to this function

try_again_restart(SupRef, Child, Reason)

View Source 
-spec try_again_restart(SupRef, Child, Reason) -> ok
                     when SupRef :: sup_ref(), Child :: child_id() | pid(), Reason :: term().
Link to this function

which_children(SupRef)

View Source 
-spec which_children(SupRef) -> [{Id, Child, Type, Modules}]
                  when
                      SupRef :: sup_ref(),
                      Id :: child_id() | undefined,
                      Child :: child() | restarting,
                      Type :: worker(),
                      Modules :: modules().