amqp v1.5.0 AMQP.Exchange View Source

Functions to operate on Exchanges.

Link to this section Summary

Functions

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

Declares an Exchange. The default Exchange type is direct.

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

Convenience function to declare an Exchange of type direct.

Convenience function to declare an Exchange of type fanout.

Convenience function to declare an Exchange of type topic.

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

Link to this section Functions

Link to this function

bind(channel, destination, source, options \\ [])

View Source

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 [].
Link to this function

declare(channel, exchange, type \\ :direct, options \\ [])

View Source

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 [].
Link to this function

delete(channel, exchange, options \\ [])

View Source

Specs

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.
Link to this function

direct(channel, exchange, options \\ [])

View Source

Specs

Convenience function to declare an Exchange of type direct.

Options

This function takes the same options as declare/4.

Link to this function

fanout(channel, exchange, options \\ [])

View Source

Specs

Convenience function to declare an Exchange of type fanout.

Options

This function takes the same options as declare/4.

Link to this function

topic(channel, exchange, options \\ [])

View Source

Specs

Convenience function to declare an Exchange of type topic.

Options

This function takes the same options as declare/4.

Link to this function

unbind(channel, destination, source, options \\ [])

View Source

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 [].