hare v0.2.0 Hare.Context.Action.Qos

This module implements a Hare.Context.Action behaviour to declare a qos.

Config

Configuration must be a Keyword.t with the following fields:

The action configuration

Runs the action

Validates the given config format

config()

config() :: [{:prefetch_count, integer}]

The action configuration

run(chan, config, exports)

Runs the action.

It receives a open AMQP channel, the config of the action, and the exports map, containing data from previous run actions.

It may return 4 possible values:

:ok - On success (info is %{} by default)
{:ok, info} - On success, providing some info about the execution of the step
{:ok, info, exports} - On success, providing some info, with a modified exports map
{:error, reason} - On error

Callback implementation for Hare.Context.Action.run/3.

validate(config)

Validates the given config format.

It must return :ok if config is valid, and {:error, reason} if it is invalid.