hare v0.1.9 Hare.Context.Action.DeleteQueue

This module implements a Hare.Context.Action behaviour to delete an queue from the AMQP server.

Config

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

:name - the name of the queue
:opts - (defaults to []) the options to be given to the adapter
:export_as - (defaults to nil) the key to export the deleted queue to

The :export_as config allows the action to export a Hare.Core.Queue struct to be used later by other steps (for example: to redeclare it with another opts).

alias Hare.Context.Action.DeleteQueue

config = [name: "foo",
          opts: [no_wait: true],
          export_as: :deleted_ex]

exports = %{}

DeleteQueue.run(chan, config, exports)
# => {:ok, nil, %{deleted_ex: %Hare.Core.Queue{chan: chan, name: "foo"}}}

Summary

Types

config()

The action configuration

Functions

run(chan, config, exports)

Runs the action

validate(config)

Validates the given config format

Types

config()

config() :: %{:name => binary, optional(:opts) => Keyword.t, optional(:export_as) => atom}

The action configuration

Functions

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.

Callback implementation for Hare.Context.Action.validate/1.