| Overview |  |
Behaviours: gen_fsm.
This module defines the riak_core_coverage_fsm behaviour.
Required callback functions: init/2, process_results/2, finish/2.
The coverage fsm is a behavior used to create a plan to cover a set of VNodes, distribute a specified command to each VNode in the plan and then compile the results.
The number of VNodes required for full coverage is based on the number of partitions, the bucket n_val, and the number of primary VNodes from the preference list that are configured to be used by the module implementing this behavior.
Modules implementing this behavior should return a 5 member tuple from their init function that looks like this:
{Request, VNodeSelector, NVal, PrimaryVNodeCoverage,
NodeCheckService, VNodeMaster, Timeout, State}
The description of the tuple members is as follows:
all to indicate that
enough VNodes must be available to achieve a minimal
covering set or allup to use whatever VNodes are
available even if they do not represent a fully covering
set.from() = {atom(), req_id(), pid()}
req_id() = non_neg_integer()
| start_link/3 | Start a riak_core_coverage_fsm. |
start_link(Mod::module(), From::from(), RequestArgs::[term()]) -> {ok, pid()} | ignore | {error, term()}
Start a riak_core_coverage_fsm.
Generated by EDoc