Skip to content

Fix/typespecs #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sasa1977 wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Fix/typespecs #3

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2feb01d
gen_fsm conformant typespec for pool
sasa1977 May 20, 2014
83beae6
supervisor conformant typespec
sasa1977 May 20, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 20 additions & 13 deletions src/poolboy.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,13 @@

-define(TIMEOUT, 5000).

-type pool() ::
Name :: atom() |
{Name :: atom(), node()} |
{local, Name :: atom()} |
{global, GlobalName :: any()} |
{via, Module :: atom(), ViaName :: any()}.

-record(state, {
supervisor :: pid(),
workers :: queue(),
Expand All @@ -29,24 +36,24 @@
max_overflow = 10 :: non_neg_integer()
}).

-spec checkout(Pool :: node()) -> pid().
-spec checkout(Pool :: pool()) -> pid().
checkout(Pool) ->
checkout(Pool, true).

-spec checkout(Pool :: node(), Block :: boolean()) -> pid() | full.
-spec checkout(Pool :: pool(), Block :: boolean()) -> pid() | full.
checkout(Pool, Block) ->
checkout(Pool, Block, ?TIMEOUT).

-spec checkout(Pool :: node(), Block :: boolean(), Timeout :: timeout())
-spec checkout(Pool :: pool(), Block :: boolean(), Timeout :: timeout())
-> pid() | full.
checkout(Pool, Block, Timeout) ->
gen_fsm:sync_send_event(Pool, {checkout, Block, Timeout}, Timeout).

-spec checkin(Pool :: node(), Worker :: pid()) -> ok.
-spec checkin(Pool :: pool(), Worker :: pid()) -> ok.
checkin(Pool, Worker) when is_pid(Worker) ->
gen_fsm:send_event(Pool, {checkin, Worker}).

-spec transaction(Pool :: node(), Fun :: fun((Worker :: pid()) -> any()))
-spec transaction(Pool :: pool(), Fun :: fun((Worker :: pid()) -> any()))
-> any().
transaction(Pool, Fun) ->
Worker = poolboy:checkout(Pool),
Expand All @@ -56,17 +63,17 @@ transaction(Pool, Fun) ->
ok = poolboy:checkin(Pool, Worker)
end.

-spec child_spec(Pool :: node(), PoolArgs :: proplists:proplist())
-spec child_spec(PoolId :: term(), PoolArgs :: proplists:proplist())
-> supervisor:child_spec().
child_spec(Pool, PoolArgs) ->
child_spec(Pool, PoolArgs, []).
child_spec(PoolId, PoolArgs) ->
child_spec(PoolId, PoolArgs, []).

-spec child_spec(Pool :: node(),
-spec child_spec(PoolId :: term(),
PoolArgs :: proplists:proplist(),
WorkerArgs :: proplists:proplist())
-> supervisor:child_spec().
child_spec(Pool, PoolArgs, WorkerArgs) ->
{Pool, {poolboy, start_link, [PoolArgs, WorkerArgs]},
child_spec(PoolId, PoolArgs, WorkerArgs) ->
{PoolId, {poolboy, start_link, [PoolArgs, WorkerArgs]},
permanent, 5000, worker, [poolboy]}.

-spec start(PoolArgs :: proplists:proplist())
Expand All @@ -92,11 +99,11 @@ start_link(PoolArgs) ->
start_link(PoolArgs, WorkerArgs) ->
start_pool(start_link, PoolArgs, WorkerArgs).

-spec stop(Pool :: node()) -> ok.
-spec stop(Pool :: pool()) -> ok.
stop(Pool) ->
gen_fsm:sync_send_all_state_event(Pool, stop).

-spec status(Pool :: node()) -> {atom(), integer(), integer(), integer()}.
-spec status(Pool :: pool()) -> {atom(), integer(), integer(), integer()}.
status(Pool) ->
gen_fsm:sync_send_all_state_event(Pool, status).

Expand Down