leo_statistics_sampler¶

Description
Function Index
Function Details

The statistics data sampler.

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

References

https://github.com/leo-project/leo_statistics/blob/master/src/leo_statistics_sampler.erl

Description¶

The statistics data sampler

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.
init/1	Initiates the server.
start_link/2	Start the server.
stop/1	Stop the server.
terminate/2	This function is called by a gen_server when it is about to terminate.

Function Details¶

code_change/3¶

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

Convert process state when code is changed

handle_call/3¶

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

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

handle_cast/2¶

handle_cast(Msg, State) -> any()

Handling cast message

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

handle_info/2¶

handle_info(X1, State) -> any()

Handling all non call/cast messages

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

init/1¶

init(X1) -> any()

Initiates the server

start_link/2¶

start_link(Mod, ExpireTime) -> {ok, Pid} | ignore | {error, Error}

Mod = module()
ExpireTime = pos_integer()
Pid = pid()
Error = {already_started, Pid} | term()

Start the server

stop/1¶

stop(Pid) -> ok

Pid = pid()

Stop the server

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.