Module riak_ensemble_manager

Data Types

cluster_state()

cluster_state() = riak_ensemble_state:state()

ensemble_data()

ensemble_data() = {ensemble_id(), leader_id(), vsn_views(), vsn_views()}

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_data())

epoch()

epoch() = integer()

leader_id()

leader_id() = undefined | peer_id()

orddict()

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

peer_id()

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

peer_info()

peer_info() = nodedown | undefined | {any(), boolean(), epoch()}

seq()

seq() = integer()

state()

state() = #state{version = integer(), ensemble_data = ensembles(), remote_peers = orddict(peer_id(), pid()), cluster_state = cluster_state()}

views()

views() = [[peer_id()]]

vsn()

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

vsn_views()

vsn_views() = {vsn(), views()}

Function Index

check_quorum/2
cluster/0
code_change/3
count_quorum/2
create_ensemble/4
create_ensemble/5
enable/0
enabled/0
get_cluster_state/0
get_leader/1
get_leader_pid/1
get_members/1
get_peer_info/2
get_peer_pid/2
get_pending/1
get_views/1
gossip/1
gossip_pending/3
handle_call/3
handle_cast/2
handle_info/2
init/1
join/2
known_ensembles/0
remove/2
rleader_pid/0
start/0
start_link/0
terminate/2
update_ensemble/4

Function Details

check_quorum/2

check_quorum(Ensemble::ensemble_id(), Timeout::timeout()) -> boolean()

cluster/0

cluster() -> [node()]

code_change/3

code_change(OldVsn, State, Extra) -> any()

count_quorum/2

count_quorum(Ensemble::ensemble_id(), Timeout::timeout()) -> integer()

create_ensemble/4

create_ensemble(EnsembleId::ensemble_id(), PeerId::peer_id(), Mod::module(), Args::[any()]) -> ok | {error, term()}

create_ensemble/5

create_ensemble(EnsembleId::ensemble_id(), EnsLeader::leader_id(), Members::[peer_id()], Mod::module(), Args::[any()]) -> ok | {error, term()}

enable/0

enable() -> ok | error

enabled/0

enabled() -> boolean()

get_cluster_state/0

get_cluster_state() -> cluster_state()

get_leader/1

get_leader(EnsembleId::ensemble_id()) -> leader_id()

get_leader_pid/1

get_leader_pid(Ensemble::ensemble_id()) -> undefined | pid()

get_members/1

get_members(EnsembleId::ensemble_id()) -> [peer_id()]

get_peer_info/2

get_peer_info(Ensemble::ensemble_id(), Peer::peer_id()) -> nodedown | undefined | peer_info()

get_peer_pid/2

get_peer_pid(Ensemble::ensemble_id(), PeerId::peer_id()) -> pid() | undefined

get_pending/1

get_pending(EnsembleId::ensemble_id()) -> {vsn(), [[peer_id()]]} | undefined

get_views/1

get_views(EnsembleId::ensemble_id()) -> {vsn(), views()}

gossip/1

gossip(CS) -> any()

gossip_pending/3

gossip_pending(Ensemble, Vsn, Views) -> any()

handle_call/3

handle_call(Request, From, State) -> any()

handle_cast/2

handle_cast(Msg, State) -> any()

handle_info/2

handle_info(Info, State) -> any()

init/1

init(X1::[]) -> {ok, state()}

join/2

join(Same, OtherNode) -> any()

known_ensembles/0

known_ensembles() -> undefined | {ok, orddict(ensemble_id(), ensemble_info())}

remove/2

remove(Same, NodeToRemove) -> any()

rleader_pid/0

rleader_pid() -> pid() | undefined

start/0

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

start_link/0

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

terminate/2

terminate(Reason, State) -> any()

update_ensemble/4

update_ensemble(Ensemble::ensemble_id(), Leader::peer_id(), Views::views(), Vsn::vsn()) -> ok


Generated by EDoc