poolgirl (poolgirl v2.2.1)
Link to this section Summary
Functions
This function exists for compatibility with
poolboy
onlyFetch a worker from a pool
The same as child_spec/3 with no configuration options
The pool spec to use under your supervision tree
List your pool's workers
Change your pool's size
Fetch the status of a pool
Kill your pool
Execute your function in the context of a pool worker
Link to this section Types
Link to this type
pool/0
Specs
pool() :: Name :: atom().
Link to this type
start_ret/0
Specs
start_ret() :: {ok, pid()} | {error, term()}.
Link to this section Functions
Link to this function
checkin(PoolId, Worker)
Specs
checkin(PoolId :: pool(), Worker :: pid()) -> ok.
poolboy
only
Link to this function
checkout(PoolId)
Specs
checkout(PoolId :: pool()) -> no_process | pid().
Link to this function
child_spec(PoolId, PoolArgs)
Specs
child_spec(PoolId :: term(), PoolArgs :: proplists:proplist()) -> supervisor:child_spec().
Link to this function
child_spec(PoolId, PoolArgs, WorkerArgs)
Specs
child_spec(PoolId :: term(), PoolArgs :: proplists:proplist(), WorkerArgs :: proplists:proplist()) -> supervisor:child_spec().
Link to this function
get_workers(PoolId)
Specs
get_workers(PoolId :: pool()) -> list().
Link to this function
spin(UpOrDown, PoolId, HowMany)
Specs
spin(UpOrDown :: up | down, PoolId :: pool(), HowMany :: pos_integer()) -> ok.
Link to this function
status(PoolId)
Specs
status(PoolId :: pool()) -> {atom(), integer()}.
Link to this function
stop(PoolId)
Specs
stop(PoolId :: pool()) -> ok.
Link to this function
transaction(PoolId, Fun)
Specs
transaction(PoolId :: pool(), Fun :: fun((Worker :: pid()) -> any())) -> any().