Module gen_batch_server

Data Types
Function Index
Function Details

This module defines the gen_batch_server behaviour.
Required callback functions: init/1, handle_batch/2.
Optional callback functions: handle_continue/2, format_status/1, terminate/2.

Data Types

action()

action() = {reply, from(), Msg::term()} | garbage_collect

an action that can be returned from handle_batch/2

from()

from() = {Pid::pid(), Tag::reference()}

op()

op() = {cast, pid(), UserOp::term()} | {call, from(), UserOp::term()} | {info, UserOp::term()}

server_ref()

server_ref() = pid() | (LocalName::atom()) | {Name::atom(), Node::atom()} | {global, term()} | {via, Module::module(), Name::term()}

Function Index

call/2
call/3
cast/2
cast_batch/2
format_status/2
init_it/6
loop_wait/2
start_link/2
start_link/3
start_link/4
stop/1
stop/3
system_continue/3
system_get_state/1
system_terminate/4
write_debug/3

Function Details

call/2

call(Name::server_ref(), Request::term()) -> term()

call/3

call(Name::pid() | atom(), Request::term(), Timeout::non_neg_integer()) -> term()

cast/2

cast(Dest::server_ref(), Request::term()) -> ok

cast_batch/2

cast_batch(Dest::server_ref(), Batch::[term()]) -> ok

format_status/2

format_status(Reason, X2) -> any()

init_it/6

init_it(Starter, Parent, Name, Mod, Args, Options) -> any()

loop_wait/2

loop_wait(State, Parent) -> any()

start_link/2

start_link(Mod, Args) -> Result

Mod = module()
Args = term()
Result = {ok, pid()} | {error, {already_started, pid()}}

start_link/3

start_link(Name, Mod, Args) -> Result

Name = {local, atom()} | {global, term()} | {via, atom(), term()} | undefined
Mod = module()
Args = term()
Result = {ok, pid()} | {error, {already_started, pid()}}

start_link/4

start_link(Name, Mod, Args, Options) -> Result

Name = {local, atom()} | {global, term()} | {via, atom(), term()} | undefined
Mod = module()
Args = term()
Options = list()
Result = {ok, pid()} | {error, {already_started, pid()}}

stop/1

stop(Name) -> any()

stop/3

stop(Name, Reason, Timeout) -> any()

system_continue/3

system_continue(Parent, Debug, State) -> any()

system_get_state/1

system_get_state(State) -> any()

system_terminate/4

system_terminate(Reason::term(), Parent::pid(), Debug::list(), State::term()) -> no_return()

write_debug/3

write_debug(Dev, Event, Name) -> any()

Generated by EDoc