Module aequitas

Function Index
Function Details

Function Index

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.

Function Details

ask/2

ask(Category, ActorId) -> Status | {error, Reason}

Category = term()
ActorId = term()
Status = accepted | {rejected, RejectionReason}
RejectionReason = outlier | rate_limited
Reason = not_started

Like :ask/3 but with default options

See also: ask/3, async_ask/2, async_ask/3.

ask/3

ask(Category, ActorId, Opts) -> Status | {Status, Stats} | {error, Reason}

Category = term()
ActorId = term()
Opts = [aequitas_category:ask_opt()]
Status = accepted | {rejected, RejectionReason}
RejectionReason = outlier | rate_limited
Stats = aequitas_work_stats:t()
Reason = not_started

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() values

Returns:

accepted if work execution was granted
{rejected, Reason} if work execution was denied
{error, Reason} if something went wrong

See also: ask/2, async_ask/2, async_ask/3.

async_ask/2

async_ask(Category, ActorId) -> {Tag, Monitor}

Category = term()
ActorId = term()
Tag = reference()
Monitor = reference()

Like :async_ask/3 but with default options

See also: ask/2, ask/3, async_ask/3.

async_ask/3

async_ask(Category, ActorId, Opts) -> {Tag, Monitor}

Category = term()
ActorId = term()
Opts = [aequitas_category:ask_opt()]
Tag = reference()
Monitor = reference()

Like :ask/3 but the reply is sent asynchronously

Returns a {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 stopped

In case of a successful reply, don't forget to clean Monitor up, which can be done like this: demonitor(Monitor, [flush])

See also: ask/2, ask/3, async_ask/2.

reconfigure/2

reconfigure(Category, SettingOpts) -> ok | {error, Reason}

Category = term()
SettingOpts = [aequitas_category:setting_opt()]
Reason = not_started | {invalid_setting_opt | invalid_setting_opts, term()}

Tweak settings of work Category

Category must refer to a started category handler.
SettingOpts must be a list of aequitas_category:setting_opt() values

Returns:

ok in case of success
{error, Reason} otherwise

See also: start/2, stop/1.

start/1

start(Category) -> ok | {error, Reason}

Category = term()
Reason = already_started

Like :async_ask/3 but with default options

See also: reconfigure/2, start/2, stop/1.

start/2

start(Category, Opts) -> ok | {error, Reason}

Category = term()
Opts = [aequitas_category:setting_opt()]
Reason = already_started | {invalid_setting_opt, term()} | {invalid_setting_opts, term()}

Starts handler for Category

Category can be any term.
Opts must be a list of aequitas_category:setting_opt() values.

Returns:

ok in case of success
{error, Reason} otherwise

See also: reconfigure/2, start/1, stop/1.

stop/1

stop(Category) -> ok | {error, Reason}

Category = term()
Reason = not_started

Stops a Category handler

Category must correspond to a started handler

Returns:

ok in case of success
{error, Reason} otherwise

See also: reconfigure/2, start/1.

Generated by EDoc