amqp v1.3.0 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 declare/3 with the :passive option set.
Convenience to consume messages from a Queue.
Unbinds a Queue from an Exchange.
Stops the consumer identified by consumer_tag from consuming.
Link to this section Functions
bind(channel, queue, exchange, options \\ [])
View Sourcebind(AMQP.Channel.t(), AMQP.Basic.queue(), AMQP.Basic.exchange(), keyword()) :: :ok | AMQP.Basic.error()
Binds a Queue to an Exchange.
Options
:routing_key- The routing key used to bind the queue to the exchange. Defaults to"".:no_wait- Iftrue, the binding is not synchronous. Defaults tofalse.:arguments- A list of arguments to pass when binding. See the README for more information. Defaults to[].
consumer_count(channel, queue)
View Sourceconsumer_count(AMQP.Channel.t(), AMQP.Basic.queue()) :: integer() | no_return()
Returns a number of active consumers on the queue.
declare(channel, queue \\ "", options \\ [])
View Sourcedeclare(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. Defaults tofalse.:auto_delete- If set, deletes the Queue once all subscribers disconnect. Defaults tofalse.:exclusive- If set, only one subscriber can consume from the Queue. Defaults tofalse.:passive- If set, raises an error unless the queue already exists. Defaults tofalse.:no_wait- If set, the declare operation is asynchronous. Defaults tofalse.:arguments- A list of arguments to pass when declaring. See the README for more information. Defaults to[].
delete(channel, queue, options \\ [])
View Sourcedelete(AMQP.Channel.t(), AMQP.Basic.queue(), keyword()) :: {:ok, map()} | AMQP.Basic.error()
Deletes a Queue by name.
Options
:if_unused- If set, the server will only delete the queue if it has no consumers. If the queue has consumers, it's not deleted and an error is returned.:if_empty- If set, the server will only delete the queue if it has no messages.:no_wait- If set, the delete operation is asynchronous.
empty?(channel, queue)
View Sourceempty?(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 Sourcemessage_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 Sourcepurge(AMQP.Channel.t(), AMQP.Basic.queue()) :: {:ok, map()} | AMQP.Basic.error()
Discards all messages in the Queue.
status(chan, queue)
View Sourcestatus(AMQP.Channel.t(), AMQP.Basic.queue()) :: {:ok, map()} | AMQP.Basic.error()
Returns the message count and consumer count for the given queue.
Uses declare/3 with the :passive option set.
subscribe(channel, queue, fun)
View Sourcesubscribe(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 Sourceunbind(AMQP.Channel.t(), AMQP.Basic.queue(), AMQP.Basic.exchange(), keyword()) :: :ok | AMQP.Basic.error()
Unbinds a Queue from an Exchange.
Options
:routing_key- The routing queue for removing the binding. Defaults to"".:arguments- A list of arguments to pass when unbinding. See the README for more information. Defaults to[].
unsubscribe(channel, consumer_tag)
View Sourceunsubscribe(AMQP.Channel.t(), AMQP.Basic.consumer_tag()) :: {:ok, String.t()} | AMQP.Basic.error()
Stops the consumer identified by consumer_tag from consuming.
Internally just calls AMQP.Basic.cancel/2.