Behaviours: gen_server.
Authors: Your Name (your@mail.address).
state() = #state{}
void() = ok | void | none
code_change/3 | Convert process state when code is changed. |
handle_call/3 | Handling call messages. |
handle_cast/2 | Handling cast messages. |
handle_info/2 | Handling all non call/cast messages. |
init/1 | Initiates the server. |
start_link/0 | Starts the server. |
terminate/2 | This function is called by a gen_server when it is about to terminate. |
code_change(OldVsn, State, Extra) -> {ok, NewState}
Convert process state when code is changed
handle_call(Request, From, State) -> {reply, Reply, State} | {reply, Reply, State, Timeout} | {noreply, State} | {noreply, State, Timeout} | {stop, Reason, Reply, State} | {stop, Reason, State}
Handling call messages
handle_cast(Msg, State) -> {noreply, State} | {noreply, State, Timeout} | {stop, Reason, State}
Handling cast messages
handle_info(Info, State) -> {noreply, State} | {noreply, State, Timeout} | {stop, Reason, State}
Handling all non call/cast messages
init(X1::Args) -> {ok, State} | {ok, State, Timeout} | ignore | {stop, Reason}
Initiates the server
start_link() -> {ok, Pid} | ignore | {error, Error}
Starts the server
terminate(Reason, State) -> void()
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. The return value is ignored.
Generated by EDoc, Dec 3 2008, 13:34:23.