shackle_pool (shackle v0.7.1)

View Source

Summary

Types

max_retries/0
name/0
option/0
options/0
pool_size/0
pool_strategy/0

Functions

init()
server(Name)
start(Name, Client, ClientOptions)
start(Name, Client, ClientOptions, Options)
stop(Name)
terminate()

Types

max_retries/0

-type max_retries() :: non_neg_integer().

name/0

-type name() :: atom().

option/0

-type option() ::
          {backlog_size, shackle_backlog:backlog_size()} |
          {max_retries, max_retries()} |
          {pool_size, pool_size()} |
          {pool_strategy, pool_strategy()}.

options/0

-type options() :: [option()].

pool_size/0

-type pool_size() :: pos_integer().

pool_strategy/0

-type pool_strategy() :: random | round_robin.

Functions

init()

-spec init() -> ok.

server(Name)

-spec server(shackle_pool:name()) ->
                {ok, shackle:client(), atom()} |
                {error, pool_not_started | no_server | shackle_not_started}.

start(Name, Client, ClientOptions)

-spec start(shackle_pool:name(), shackle:client(), shackle_client:options()) ->
               ok | {error, shackle_not_started | pool_already_started}.

start(Name, Client, ClientOptions, Options)

-spec start(shackle_pool:name(), shackle:client(), shackle_client:options(), options()) ->
               ok | {error, shackle_not_started | pool_already_started}.

stop(Name)

-spec stop(shackle_pool:name()) -> ok | {error, shackle_not_started | pool_not_started}.

terminate()

-spec terminate() -> ok.