Module octopus

get_group(GroupId) -> PoolList

• GroupId = atom()
• PoolList = list()

get_pool_config(PoolId) -> Tuple | false

• PoolId = atom()
• Tuple = tuple()

map(GroupId, Fun) -> list()

• GroupId = atom()
• PoolId = atom()
• Fun = fun((PoolId) -> term())

perform(PoolId, Fun) -> FunResult | {error, Reason}

• PoolId = atom()
• Fun = fun((pid()) -> term())
• FunResult = term()
• Reason = term()

pool_info(PoolId) -> [{Item, non_neg_integer()}]

• PoolId = atom()
• Item = init | ready | busy

pool_info(PoolId, Item) -> non_neg_integer()

• PoolId = atom()
• Item = init | ready | busy

reduce(GroupId, Fun, InitState) -> term()

• GroupId = atom()
• PoolId = atom()
• InitState = term()
• Fun = fun((PoolId, InitState) -> term())

set_group(GroupId, PoolList) -> ok

• GroupId = atom()
• PoolList = list()

set_pool_config(PoolId, PoolOpts, WorkerArgs) -> ok

• PoolId = atom()
• PoolOpts = proplists:proplist()
• WorkerArgs = proplists:proplist()

set_pool_config(PoolId, PoolOpts, WorkerArgs, ChangeOpts) -> ok

• PoolId = atom()
• PoolOpts = proplists:proplist()
• WorkerArgs = proplists:proplist()
• ChangeOpts = proplists:proplist()

start_pool(PoolId, PoolOpts, WorkerArgs) -> ok | {error, Reason}

• PoolId = atom()
• PoolOpts = proplists:proplist()
• WorkerArgs = proplists:proplist()
• Reason = term()

stop_pool(PoolId) -> ok

• PoolId = atom()

worker_lockin(PoolId) -> ok

• PoolId = atom()

worker_lockout(PoolId) -> {ok, Pid} | {error, Reason}

• PoolId = atom()
• Pid = pid()
• Reason = term()