Module riak_ensemble_state

Data Types

ensemble_id()

ensemble_id() = term()

ensemble_info()

ensemble_info() = #ensemble_info{vsn = vsn(), mod = module(), args = [any()], leader = leader_id(), views = [[peer_id()]], seq = {integer(), integer()}}

ensembles()

ensembles() = orddict(ensemble_id(), ensemble_info())

epoch()

epoch() = integer()

leader_id()

leader_id() = undefined | peer_id()

orddict()

orddict(Key, Val) = [{Key, Val}]

ordsets()

ordsets(Val) = [Val]

peer_id()

peer_id() = {term(), node()}

pending()

pending() = orddict(ensemble_id(), {vsn(), views()})

seq()

seq() = integer()

state()

state() = #cluster_state{id = any(), enabled = boolean(), members = {vsn(), ordsets(node())}, ensembles = ensembles(), pending = pending()}

views()

views() = [[peer_id()]]

vsn()

vsn() = {epoch(), seq()}

Function Index

add_member/3
del_member/3
enable/1
enabled/1
ensembles/1
id/1
is_state/1
members/1
merge/2
new/1
pending/1
set_ensemble/3
set_pending/4
update_ensemble/5

Function Details

add_member/3

add_member(Vsn::vsn(), Node::node(), State::state()) -> {ok, state()} | error

del_member/3

del_member(Vsn::vsn(), Node::node(), State::state()) -> {ok, state()} | error

enable/1

enable(State::state()) -> {ok, state()} | error

enabled/1

enabled(Cluster_state::state()) -> boolean()

ensembles/1

ensembles(Cluster_state::state()) -> ensembles()

id/1

id(Cluster_state::state()) -> term()

is_state/1

is_state(Cluster_state::term()) -> boolean()

members/1

members(Cluster_state::state()) -> ordsets(node())

merge/2

merge(A::state(), B::state()) -> state()

new/1

new(Id::term()) -> state()

pending/1

pending(Cluster_state::state()) -> pending()

set_ensemble/3

set_ensemble(Ensemble::ensemble_id(), Info::ensemble_info(), State::state()) -> {ok, state()} | error

set_pending/4

set_pending(Vsn::vsn(), Ensemble::ensemble_id(), Views::views(), State::state()) -> {ok, state()} | error

update_ensemble/5

update_ensemble(Vsn::vsn(), Ensemble::ensemble_id(), Leader::peer_id(), Views::views(), State::state()) -> {ok, state()} | error


Generated by EDoc