Module poolboy

Behaviours: gen_server.

Data Types

pool()

pool() = atom() | pid() | {Name::atom(), node()} | {local, Name::atom()} | {global, GlobalName::any()} | {via, Module::atom(), ViaName::any()}

start_ret()

start_ret() = {ok, pid()} | ignore | {error, term()}

Function Index

checkin/2
checkout/1
checkout/2
checkout/3
child_spec/2
child_spec/3
child_spec/4
code_change/3
handle_call/3
handle_cast/2
handle_info/2
init/1
start/1
start/2
start_link/1
start_link/2
status/1
stop/1
terminate/2
transaction/2
transaction/3

Function Details

checkin/2

checkin(Pool::pool(), Worker::pid()) -> ok

checkout/1

checkout(Pool::pool()) -> pid()

checkout/2

checkout(Pool::pool(), Block::boolean()) -> pid() | full

checkout/3

checkout(Pool::pool(), Block::boolean(), Timeout::timeout()) -> pid() | full

child_spec/2

child_spec(PoolId::term(), PoolArgs::proplists:proplist()) -> supervisor:child_spec()

child_spec/3

child_spec(PoolId::term(), PoolArgs::proplists:proplist(), WorkerArgs::proplists:proplist()) -> supervisor:child_spec()

child_spec/4

child_spec(PoolId::term(), PoolArgs::proplists:proplist(), WorkerArgs::proplists:proplist(), ChildSpecFormat::tuple | map) -> supervisor:child_spec()

code_change/3

code_change(OldVsn, State, Extra) -> any()

handle_call/3

handle_call(Msg, From, State) -> any()

handle_cast/2

handle_cast(Msg, State) -> any()

handle_info/2

handle_info(Info, State) -> any()

init/1

init(X1) -> any()

start/1

start(PoolArgs::proplists:proplist()) -> start_ret()

start/2

start(PoolArgs::proplists:proplist(), WorkerArgs::proplists:proplist()) -> start_ret()

start_link/1

start_link(PoolArgs::proplists:proplist()) -> start_ret()

start_link/2

start_link(PoolArgs::proplists:proplist(), WorkerArgs::proplists:proplist()) -> start_ret()

status/1

status(Pool::pool()) -> {atom(), integer(), integer(), integer()}

stop/1

stop(Pool::pool()) -> ok

terminate/2

terminate(Reason, State) -> any()

transaction/2

transaction(Pool::pool(), Fun::fun((Worker::pid()) -> any())) -> any()

transaction/3

transaction(Pool::pool(), Fun::fun((Worker::pid()) -> any()), Timeout::timeout()) -> any()


Generated by EDoc