worker_pool
v6.1.0

View Source wpool_pool (worker_pool v6.1.0)

A pool of workers. If you want to put it in your supervisor tree, remember it's a supervisor.

Link to this section Summary

Types

wpool/0

Functions

add_callback_module(Pool, Module)
Adds a callback module. The module must implement the
wpool_process_callbacks
behaviour.
best_worker(Name)
Picks the worker with the smaller queue of messages.
broadcast(Name, Cast)
Casts a message to all the workers within the given pool.
call_available_worker(Name, Call, Timeout)
Picks the first available worker and sends the call to it. The timeout provided includes the time it takes to get a worker and for it to process the call.
cast_to_available_worker(Name, Cast)
Casts a message to the first available worker. Since we can wait forever for a wpool:cast to be delivered but we don't want the caller to be blocked, this function just forwards the cast when it gets the worker
find_wpool(Name)
Use this function to get the Worker pool record in a custom worker.
get_workers(Name)
Retrieves the list of worker registered names. This can be useful to manually inspect the workers or do custom work on them.
hash_worker(Name, HashKey)
Picks a worker base on a hash result.
phash2(Term, Range)
returns hash = integer, 0 <= hash < Range so
1
must be added
next(Next, Wpool)
Set next within the worker pool record. Useful when using a custom strategy function.
next_available_worker(Name)
Picks the first available worker, if any
next_worker(Name)
Picks the next worker in a round robin fashion
random_worker(Name)
Picks a random worker
remove_callback_module(Pool, Module)
Removes a callback module.
send_request_available_worker(Name, Call, Timeout)
Picks the first available worker and sends the request to it. The timeout provided considers only the time it takes to get a worker
start_link(Name, Options)
Starts a supervisor with several wpool_processes as its children
stats()
Retrieves the pool stats for all pools
stats(Name)
Retrieves a snapshot of the pool stats
worker_name(Name, I)
wpool_get(List, Wpool)
Get values from the worker pool record. Useful when using a custom strategy function.

Link to this section Types

Link to this opaque

wpool/0

View Source (opaque) 
-opaque wpool()

Link to this section Functions

Link to this function

add_callback_module(Pool, Module)

View Source 
-spec add_callback_module(wpool:name(), module()) -> ok | {error, term()}.
Adds a callback module. The module must implement the
wpool_process_callbacks
behaviour.
Link to this function

best_worker(Name)

View Source 
-spec best_worker(wpool:name()) -> atom().
Picks the worker with the smaller queue of messages.
Link to this function

broadcast(Name, Cast)

View Source 
-spec broadcast(wpool:name(), term()) -> ok.
Casts a message to all the workers within the given pool.
Link to this function

call_available_worker(Name, Call, Timeout)

View Source 
-spec call_available_worker(wpool:name(), any(), timeout()) -> atom().
Picks the first available worker and sends the call to it. The timeout provided includes the time it takes to get a worker and for it to process the call.
Link to this function

cast_to_available_worker(Name, Cast)

View Source 
-spec cast_to_available_worker(wpool:name(), term()) -> ok.
Casts a message to the first available worker. Since we can wait forever for a wpool:cast to be delivered but we don't want the caller to be blocked, this function just forwards the cast when it gets the worker
Link to this function

find_wpool(Name)

View Source 
-spec find_wpool(atom()) -> undefined | wpool().
Use this function to get the Worker pool record in a custom worker.
Link to this function

get_workers(Name)

View Source 
-spec get_workers(wpool:name()) -> [atom()].
Retrieves the list of worker registered names. This can be useful to manually inspect the workers or do custom work on them.
Link to this function

hash_worker(Name, HashKey)

View Source 
-spec hash_worker(wpool:name(), term()) -> atom().
Picks a worker base on a hash result.
phash2(Term, Range)
returns hash = integer, 0 <= hash < Range so
1
must be added
Link to this function

next(Next, Wpool)

View Source 
-spec next(pos_integer(), wpool()) -> wpool().
Set next within the worker pool record. Useful when using a custom strategy function.
Link to this function

next_available_worker(Name)

View Source 
-spec next_available_worker(wpool:name()) -> atom().
Picks the first available worker, if any
Link to this function

next_worker(Name)

View Source 
-spec next_worker(wpool:name()) -> atom().
Picks the next worker in a round robin fashion
Link to this function

random_worker(Name)

View Source 
-spec random_worker(wpool:name()) -> atom().
Picks a random worker
Link to this function

remove_callback_module(Pool, Module)

View Source 
-spec remove_callback_module(wpool:name(), module()) -> ok | {error, term()}.
Removes a callback module.
Link to this function

send_request_available_worker(Name, Call, Timeout)

View Source 
-spec send_request_available_worker(wpool:name(), any(), timeout()) ->
                                 noproc | timeout | gen_server:request_id().
Picks the first available worker and sends the request to it. The timeout provided considers only the time it takes to get a worker
Link to this function

start_link(Name, Options)

View Source 
-spec start_link(wpool:name(), [wpool:option()]) ->
              {ok, pid()} | {error, {already_started, pid()} | term()}.
Starts a supervisor with several wpool_processes as its children
Link to this function

stats()

View Source 
-spec stats() -> [wpool:stats()].
Retrieves the pool stats for all pools
Link to this function

stats(Name)

View Source 
-spec stats(wpool:name()) -> wpool:stats().
Retrieves a snapshot of the pool stats
Link to this function

worker_name(Name, I)

View Source 
-spec worker_name(wpool:name(), pos_integer()) -> atom().
Link to this function

wpool_get(List, Wpool)

View Source 
-spec wpool_get(atom(), wpool()) -> any();
         ([atom()], wpool()) -> any().
Get values from the worker pool record. Useful when using a custom strategy function.