amqp v1.2.1 AMQP.Queue View Source
Functions to operate on Queues.
Link to this section Summary
Functions
Binds a Queue to an Exchange
Returns a number of active consumers on the queue.
Declares a queue. The optional queue parameter is used to set the name.
If set to an empty string (default), the server will assign a name.
Deletes a Queue by name
Returns true if queue is empty (has no messages ready), false otherwise.
Returns the number of messages that are ready for delivery (e.g. not pending acknowledgements) in the queue.
Discards all messages in the Queue
Returns the message count and consumer count for the given queue.
Uses Queue.declare with the passive option set.
Convenience to consume messages from a Queue.
Unbinds a Queue from an Exchange
Convenience to end a Queue consumer.
Link to this section Functions
bind(channel, queue, exchange, options \\ [])
View Source
bind(AMQP.Channel.t(), AMQP.Basic.queue(), AMQP.Basic.exchange(), keyword()) ::
:ok | AMQP.Basic.error()
bind(AMQP.Channel.t(), AMQP.Basic.queue(), AMQP.Basic.exchange(), keyword()) :: :ok | AMQP.Basic.error()
Binds a Queue to an Exchange
consumer_count(channel, queue)
View Source
consumer_count(AMQP.Channel.t(), AMQP.Basic.queue()) :: integer() | no_return()
consumer_count(AMQP.Channel.t(), AMQP.Basic.queue()) :: integer() | no_return()
Returns a number of active consumers on the queue.
declare(channel, queue \\ "", options \\ [])
View Source
declare(AMQP.Channel.t(), AMQP.Basic.queue(), keyword()) ::
{:ok, map()} | AMQP.Basic.error()
declare(AMQP.Channel.t(), AMQP.Basic.queue(), keyword()) :: {:ok, map()} | AMQP.Basic.error()
Declares a queue. The optional queue parameter is used to set the name.
If set to an empty string (default), the server will assign a name.
Besides the queue name, the following options can be used:
Options
:durable- If set, keeps the Queue between restarts of the broker:auto_delete- If set, deletes the Queue once all subscribers disconnect:exclusive- If set, only one subscriber can consume from the Queue:passive- If set, raises an error unless the queue already exists
delete(channel, queue, options \\ [])
View Source
delete(AMQP.Channel.t(), AMQP.Basic.queue(), keyword()) ::
{:ok, map()} | AMQP.Basic.error()
delete(AMQP.Channel.t(), AMQP.Basic.queue(), keyword()) :: {:ok, map()} | AMQP.Basic.error()
Deletes a Queue by name
empty?(channel, queue)
View Source
empty?(AMQP.Channel.t(), AMQP.Basic.queue()) :: boolean() | no_return()
empty?(AMQP.Channel.t(), AMQP.Basic.queue()) :: boolean() | no_return()
Returns true if queue is empty (has no messages ready), false otherwise.
message_count(channel, queue)
View Source
message_count(AMQP.Channel.t(), AMQP.Basic.queue()) :: integer() | no_return()
message_count(AMQP.Channel.t(), AMQP.Basic.queue()) :: integer() | no_return()
Returns the number of messages that are ready for delivery (e.g. not pending acknowledgements) in the queue.
purge(channel, queue)
View Source
purge(AMQP.Channel.t(), AMQP.Basic.queue()) ::
{:ok, map()} | AMQP.Basic.error()
purge(AMQP.Channel.t(), AMQP.Basic.queue()) :: {:ok, map()} | AMQP.Basic.error()
Discards all messages in the Queue
status(chan, queue)
View Source
status(AMQP.Channel.t(), AMQP.Basic.queue()) ::
{:ok, map()} | AMQP.Basic.error()
status(AMQP.Channel.t(), AMQP.Basic.queue()) :: {:ok, map()} | AMQP.Basic.error()
Returns the message count and consumer count for the given queue.
Uses Queue.declare with the passive option set.
subscribe(channel, queue, fun)
View Source
subscribe(AMQP.Channel.t(), AMQP.Basic.queue(), (String.t(), map() -> any())) ::
{:ok, String.t()} | AMQP.Basic.error()
subscribe(AMQP.Channel.t(), AMQP.Basic.queue(), (String.t(), map() -> any())) :: {:ok, String.t()} | AMQP.Basic.error()
Convenience to consume messages from a Queue.
The handler function must have arity 2 and will receive as arguments a binary with the message payload and a Map with the message properties.
The consumed message will be acknowledged after executing the handler function. If an exception is raised by the handler function, the message is rejected.
This convenience function will spawn a process and register it using AMQP.Basic.consume.
unbind(channel, queue, exchange, options \\ [])
View Source
unbind(AMQP.Channel.t(), AMQP.Basic.queue(), AMQP.Basic.exchange(), keyword()) ::
:ok | AMQP.Basic.error()
unbind(AMQP.Channel.t(), AMQP.Basic.queue(), AMQP.Basic.exchange(), keyword()) :: :ok | AMQP.Basic.error()
Unbinds a Queue from an Exchange
unsubscribe(channel, consumer_tag)
View Source
unsubscribe(AMQP.Channel.t(), AMQP.Basic.consumer_tag()) ::
{:ok, String.t()} | AMQP.Basic.error()
unsubscribe(AMQP.Channel.t(), AMQP.Basic.consumer_tag()) :: {:ok, String.t()} | AMQP.Basic.error()
Convenience to end a Queue consumer.