ask/2 | Like :ask/3 but with default options. |
ask/3 | Request permission to perform work, identified under ActorId , within Category |
async_ask/2 | Like :async_ask/3 but with default options. |
async_ask/3 | Like :ask/3 but the reply is sent asynchronously. |
reconfigure/2 | Tweak settings of work Category |
start/1 | Like :async_ask/3 but with default options. |
start/2 | Starts handler for Category |
stop/1 | Stops a Category handler. |
ask(Category, ActorId) -> Status | {error, Reason}
Like :ask/3
but with default options
See also: ask/3, async_ask/2, async_ask/3.
ask(Category, ActorId, Opts) -> Status | {Status, Stats} | {error, Reason}
Request permission to perform work, identified under ActorId
, within Category
Category
must refer to a started category handler.ActorId
can be any term.Opts
must be a list of aequitas_category:ask_opt()
valuesaccepted
if work execution was granted{rejected, Reason}
if work execution was denied{error, Reason}
if something went wrongSee also: ask/2, async_ask/2, async_ask/3.
async_ask(Category, ActorId) -> {Tag, Monitor}
Like :async_ask/3
but with default options
See also: ask/2, ask/3, async_ask/3.
async_ask(Category, ActorId, Opts) -> {Tag, Monitor}
Like :ask/3
but the reply is sent asynchronously
{Tag, Monitor}
pair whose members can be used
to pattern match against the reply, which will be sent as a message
to the calling process in one of the following formats:
{Tag, accepted}
if work execution as granted{Tag, {rejected, Reason}}
if work execution was denied{Tag, {accepted, Stats}}
if work execution as granted and stats requested{Tag, {{rejected, Reason}, Stats}}
if work execution was denied and stats requested{
'DOWN
', Monitor, process, _Pid, _Reason}
if the handler stoppedMonitor
up,
which can be done like this:
demonitor(Monitor, [flush])
See also: ask/2, ask/3, async_ask/2.
reconfigure(Category, SettingOpts) -> ok | {error, Reason}
Tweak settings of work Category
Category
must refer to a started category handler.SettingOpts
must be a list of aequitas_category:setting_opt()
valuesok
in case of success{error, Reason}
otherwisestart(Category) -> ok | {error, Reason}
Like :async_ask/3
but with default options
See also: reconfigure/2, start/2, stop/1.
start(Category, Opts) -> ok | {error, Reason}
Starts handler for Category
Category
can be any term.Opts
must be a list of aequitas_category:setting_opt()
values.ok
in case of success{error, Reason}
otherwiseSee also: reconfigure/2, start/1, stop/1.
stop(Category) -> ok | {error, Reason}
Stops a Category
handler
Category
must correspond to a started handlerok
in case of success{error, Reason}
otherwiseSee also: reconfigure/2, start/1.
Generated by EDoc