amqp v0.3.1 AMQP.Exchange View Source

Functions to operate on Exchanges.

Link to this section Summary

Binds an Exchange to another Exchange or a Queue 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)

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

bind(AMQP.Channel.t, String.t, String.t, keyword) :: :ok

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

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

declare(AMQP.Channel.t, String.t, atom, keyword) :: :ok

Declares an Exchange. The default Exchange type is direct.

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

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

: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.

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

delete(AMQP.Channel.t, String.t, keyword) :: :ok

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

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

direct(AMQP.Channel.t, String.t, keyword) :: :ok

Convenience function to declare an Exchange of type direct.

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

fanout(AMQP.Channel.t, String.t, keyword) :: :ok

Convenience function to declare an Exchange of type fanout.

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

topic(AMQP.Channel.t, String.t, keyword) :: :ok

Convenience function to declare an Exchange of type topic.

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

unbind(AMQP.Channel.t, String.t, String.t, keyword) :: :ok

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