leo_membership_cluster_local¶

Description
Function Index
Function Details

The membership operation in the local-cluster.

Behaviours: `gen_server <gen_server.html>`__.

References

https://github.com/leo-project/leo_redundant_manager/blob/master/src/leo_membership_cluster_local.erl

Description¶

The membership operation in the local-cluster

Function Index¶

code_change/3	Convert process state when code is changed.
handle_call/3	gen_server callback - Module:handle_call(Request, From, State) -> Result.
handle_cast/2	Handling cast message.
handle_info/2	Handling all non call/cast messages.
heartbeat/0	Start the heartbeat operation.
init/1	Initiates the server.
set_proc_auditor/1	Set the process of an auditor.
start_heartbeat/0	Start the heartbeat operation.
start_link/2	Start the server.
start_link/3
stop/0	Stop the server.
stop_heartbeat/0	Stop the heartbeat operation.
terminate/2	This function is called by a gen_server when it is about to terminate.
update_manager_nodes/1	Update the manager nodes.

Function Details¶

code_change/3¶

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

Convert process state when code is changed

handle_call/3¶

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

gen_server callback - Module:handle_call(Request, From, State) -> Result

handle_cast/2¶

handle_cast(X1, State) -> any()

Handling cast message

gen_server callback - Module:handle_cast(Request, State) -> Result.

handle_info/2¶

handle_info(Info, State) -> any()

Handling all non call/cast messages

gen_server callback - Module:handle_info(Info, State) -> Result.

heartbeat/0¶

heartbeat() -> ok | {error, any()}

Start the heartbeat operation

init/1¶

init(X1) -> any()

Initiates the server

set_proc_auditor/1¶

set_proc_auditor(ProcAuditor) -> ok | {error, any()}

ProcAuditor = atom()

Set the process of an auditor

start_heartbeat/0¶

start_heartbeat() -> ok | {error, any()}

Start the heartbeat operation

start_link/2¶

start_link(ServerType, Managers) -> {ok, pid()} | {error, any()}

ServerType = atom()
Managers = [atom()]

Start the server

start_link/3¶

start_link(ServerType, Managers, Callback) -> {ok, pid()} | {error, any()}

ServerType = atom()
Managers = [atom()]
Callback = function()

stop/0¶

stop() -> any()

Stop the server

stop_heartbeat/0¶

stop_heartbeat() -> ok | {error, any()}

Stop the heartbeat operation

terminate/2¶

terminate(Reason, State) -> any()

This function is called by a gen_server when it is about to terminate. It should be the opposite of Module:init/1 and do any necessary cleaning up. When it returns, the gen_server terminates with Reason.

update_manager_nodes/1¶

update_manager_nodes(Managers) -> ok | {error, any()}

Managers = [atom()]

Update the manager nodes