Module riak_pipe_builder_sup

Supervisor for the pipe builder processes.

Behaviours: supervisor.

Description

Supervisor for the pipe builder processes.

This supervisor is mostly convenience for later investigation, to learn how many pipelines are active. No restart strategy is used.

Function Index

builder_pids/0Get information about the builders supervised here.
init/1Initialize this supervisor.
new_pipeline/2Start a new pipeline builder.
pipelines/0Get the list of pipelines hosted on this node.
start_link/0Start the supervisor.

Function Details

builder_pids/0

builder_pids() -> [{term(), supervisor:child_id(), supervisor:worker(), supervisor:modules()}]

Get information about the builders supervised here.

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_builder FSMs.

new_pipeline/2

new_pipeline(Fitting_spec::[#fitting_spec{name = undefined | term(), module = undefined | atom(), arg = undefined | term(), chashfun = riak_pipe_vnode:chashfun(), nval = riak_pipe_vnode:nval(), q_limit = pos_integer()}], Options::riak_pipe:exec_opts()) -> {ok, Pipe::#pipe{builder = undefined | pid(), fittings = undefined | [{Name::term(), #fitting{pid = undefined | pid(), ref = undefined | reference(), chashfun = undefined | riak_pipe_vnode:chashfun(), nval = undefined | riak_pipe_vnode:nval()}}], sink = undefined | #fitting{pid = undefined | pid(), ref = undefined | reference(), chashfun = undefined | riak_pipe_vnode:chashfun(), nval = undefined | riak_pipe_vnode:nval()}}} | {error, Reason::term()}

Start a new pipeline builder. Starts the builder process under this supervisor.

pipelines/0

pipelines() -> [#pipe{builder = undefined | pid(), fittings = undefined | [{Name::term(), #fitting{pid = undefined | pid(), ref = undefined | reference(), chashfun = undefined | riak_pipe_vnode:chashfun(), nval = undefined | riak_pipe_vnode:nval()}}], sink = undefined | #fitting{pid = undefined | pid(), ref = undefined | reference(), chashfun = undefined | riak_pipe_vnode:chashfun(), nval = undefined | riak_pipe_vnode:nval()}}]

Get the list of pipelines hosted on this node.

start_link/0

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

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


Generated by EDoc, Apr 3 2013, 21:57:21.