Specs

bind(
  AMQP.Channel.t(),
  destination :: String.t(),
  source :: String.t(),
  keyword()
) :: :ok | AMQP.Basic.error()

Binds an Exchange to another Exchange using the exchange.bind AMQP method (a RabbitMQ-specific extension).

Options

• :routing_key - the routing key to use for the binding. Defaults to "".
• :no_wait - If set, the bind operation is asynchronous. Defaults to false.
• :arguments - A list of arguments to pass when binding (of type AMQP.arguments/0). See the README for more information. Defaults to [].

Specs

declare(AMQP.Channel.t(), AMQP.Basic.exchange(), type :: atom(), keyword()) ::
  :ok | AMQP.Basic.error()

Declares an Exchange. The default Exchange type is direct.

AMQP 0-9-1 brokers provide four pre-declared exchanges:

• :direct exchange: (empty string) or amq.direct
• :fanout exchange: amq.fanout
• :topic exchange: amq.topic
• :headers exchange: amq.match (and amq.headers in RabbitMQ)

Besides the exchange name and type, the following options can be used:

Options

• :durable - If set, keeps the Exchange between restarts of the broker;
• :auto_delete - If set, deletes the Exchange once all queues unbind from it;
• :passive - If set, returns an error if the Exchange does not already exist;
• :internal - If set, the exchange may not be used directly by publishers, but only when bound to other exchanges. Internal exchanges are used to construct wiring that is not visible to applications.
• :no_wait - If set, the declare operation is asynchronous. Defaults to false.
• :arguments - A list of arguments to pass when declaring (of type AMQP.arguments/0). See the README for more information. Defaults to [].

Specs

delete(AMQP.Channel.t(), AMQP.Basic.exchange(), keyword()) ::
  :ok | AMQP.Basic.error()

Deletes an Exchange by name. When an Exchange is deleted all bindings to it are also deleted.

Options

• :if_unused - If set, the server will only delete the exchange if it has no queue bindings.
• :no_wait - If set, the delete operation is asynchronous. Defaults to false.

Specs

direct(AMQP.Channel.t(), AMQP.Basic.exchange(), keyword()) ::
  :ok | AMQP.Basic.error()

Convenience function to declare an Exchange of type direct.

Options

This function takes the same options as declare/4.

Specs

fanout(AMQP.Channel.t(), AMQP.Basic.exchange(), keyword()) ::
  :ok | AMQP.Basic.error()

Convenience function to declare an Exchange of type fanout.

Options

This function takes the same options as declare/4.

Specs

topic(AMQP.Channel.t(), AMQP.Basic.exchange(), keyword()) ::
  :ok | AMQP.Basic.error()

Convenience function to declare an Exchange of type topic.

Options

This function takes the same options as declare/4.

Specs

unbind(
  AMQP.Channel.t(),
  destination :: String.t(),
  source :: String.t(),
  keyword()
) :: :ok | AMQP.Basic.error()

Unbinds an Exchange from another Exchange or a Queue using the exchange.unbind AMQP method (a RabbitMQ-specific extension).

Options

• :routing_key - the routing key to use for the binding. Defaults to "".
• :no_wait - If set, the declare operation is asynchronous. Defaults to false.
• :arguments - A list of arguments to pass when declaring (of type AMQP.arguments/0). See the README for more information. Defaults to [].