Authors: Fernando Benavides (elbrujohalcon@inaka.net).
custom_strategy() = fun(([atom()]) -> Atom::atom())
debug_flag() = trace | log | statistics | debug | {logfile, string()}
gen_option() = {timeout, timeout()} | {debug, [debug_flag()]} | {spawn_opt, [proc_lib:spawn_option()]}
gen_options() = [gen_option()]
name() = atom()
option() = {overrun_warning, infinity | pos_integer()} | {overrun_handler, {Module::atom(), Fun::atom()}} | {workers, pos_integer()} | {worker_opt, gen_options()} | {worker, {Module::atom(), InitArg::term()}} | {strategy, supervisor_strategy()} | {worker_type, gen_fsm | gen_server} | {pool_sup_intensity, non_neg_integer()} | {pool_sup_period, non_neg_integer()}
stats() = [{pool, name()} | {supervisor, pid()} | {options, [option()]} | {size, non_neg_integer()} | {next_worker, pos_integer()} | {total_message_queue_len, non_neg_integer()} | {workers, [{pos_integer(), worker_stats()}]}]
strategy() = best_worker | random_worker | next_worker | available_worker | next_available_worker | {hash_worker, term()} | custom_strategy()
supervisor_strategy() = {supervisor:strategy(), non_neg_integer(), pos_integer()}
worker_stats() = [{messsage_queue_len, non_neg_integer()} | {memory, pos_integer()}]
call(Sup::name(), Call::term()) -> term()
Equivalent to call(Sup, Call, default_strategy()).
call(Sup::name(), Call::term(), Strategy::strategy()) -> term()
Equivalent to call(Sup, Call, Strategy, 5000).
call(Sup::name(), Call::term(), Fun::strategy(), Timeout::timeout()) -> term()
Picks a server and issues the call to it. For all strategies except available_worker, Timeout applies only to the time spent on the actual call to the worker, because time spent finding the worker in other strategies is negligible. For available_worker the time used choosing a worker is also considered
cast(Sup::name(), Cast::term()) -> ok
Equivalent to cast(Sup, Cast, default_strategy()).
cast(Sup::name(), Cast::term(), Fun::strategy()) -> ok
Picks a server and issues the cast to it
default_strategy() -> strategy()
Default strategy
send_all_state_event(Sup::name(), Event::term()) -> ok
Equivalent to send_all_state_event(Sup, Event, default_strategy()).
send_all_state_event(Sup::name(), Event::term(), Fun::strategy()) -> ok
Picks a server and issues the event to it
send_event(Sup::name(), Event::term()) -> ok
Equivalent to send_event(Sup, Event, default_strategy()).
send_event(Sup::name(), Event::term(), Fun::strategy()) -> ok
Picks a server and issues the event to it
start() -> ok | {error, {already_started, '?MODULE'}}
Starts the application
start_pool(Name::name()) -> {ok, pid()}
Equivalent to start_pool(Name, []).
start_pool(Name::name(), Options::[option()]) -> {ok, pid()} | {error, {already_started, pid()} | term()}
Starts (and links) a pool of N wpool_processes. The result pid belongs to a supervisor (in case you want to add it to a supervisor tree)
start_sup_pool(Name::name()) -> {ok, pid()}
Equivalent to start_sup_pool(Name, []).
start_sup_pool(Name::name(), Options::[option()]) -> {ok, pid()} | {error, {already_started, pid()} | term()}
Starts a pool of N wpool_processes supervised by wpool_sup
stats() -> [stats()]
Retrieves a snapshot of the pool stats
Retrieves a snapshot of a given pool stats
stop() -> ok
Stops the application
stop_pool(Name::name()) -> ok
Stops the pool
sync_send_all_state_event(Sup::name(), Event::term()) -> term()
Equivalent to sync_send_all_state_event(Sup, Event, default_strategy()).
sync_send_all_state_event(Sup::name(), Event::term(), Strategy::strategy()) -> term()
Equivalent to sync_send_all_state_event(Sup, Event, Strategy, 5000).
sync_send_all_state_event(Sup::name(), Event::term(), Fun::strategy(), Timeout::timeout()) -> term()
Picks a fsm and issues the event to it. For all strategies except available_worker, Timeout applies only to the time spent on the actual call to the worker, because time spent finding the worker in other strategies is negligible. For available_worker the time used choosing a worker is also considered
sync_send_event(Sup::name(), Event::term()) -> term()
Equivalent to sync_send_event(Sup, Event, default_strategy()).
sync_send_event(Sup::name(), Event::term(), Strategy::strategy()) -> term()
Equivalent to sync_send_event(Sup, Event, Strategy, 5000).
sync_send_event(Sup::name(), Event::term(), Fun::strategy(), Timeout::timeout()) -> term()
Picks a fsm and issues the event to it. For all strategies except available_worker, Timeout applies only to the time spent on the actual call to the worker, because time spent finding the worker in other strategies is negligible. For available_worker the time used choosing a worker is also considered
Generated by EDoc, Apr 3 2017, 11:16:15.