Module riak_pipe_fitting_sup

Supervisor of fitting processes.

Behaviours: supervisor.

Description

Supervisor of fitting processes.

Function Index

add_fitting/4Start a new fitting under this supervisor.
init/1Initialize this supervisor.
start_link/0Start the supervisor.
terminate_fitting/1Terminate a fitting immediately.

Function Details

add_fitting/4

add_fitting(Builder::pid(), Spec::riak_pipe:fitting_spec(), Output::riak_pipe:fitting(), Options::riak_pipe:exec_opts()) -> {ok, pid(), riak_pipe:fitting()}

Start a new fitting under this supervisor.

init/1

init(X1::[]) -> {ok, {{supervisor:strategy(), pos_integer(), pos_integer()}, [supervisor:child_spec()]}}

Initialize this supervisor. This is a simple_one_for_one, whose child spec is for starting riak_pipe_fitting FSMs.

start_link/0

start_link() -> {ok, pid()} | ignore | {error, term()}

Start the supervisor. It will be registered under the atom riak_pipe_fitting_sup.

terminate_fitting/1

terminate_fitting(Fitting::riak_pipe:fitting()) -> ok | {error, term()}

Terminate a fitting immediately. Useful for tearing down pipelines that may be otherwise swamped with messages from restarting workers.


Generated by EDoc, Aug 5 2012, 06:59:09.