/ 
Crixa-0.06-TRIAL
River stage zero No dependents
/ Crixa::Queue

NAME

Crixa::Queue - A Crixa Queue

VERSION

version 0.06

DESCRIPTION

This class represents a single queue. With RabbitMQ, messages are published to exchanges, which then routes the message to one or more queues. You then consume those messages from the queue.

METHODS

This class provides the following methods:

Crixa::Queue->new(...)

This method creates a new queue object. You should not call this method directly under normal circumstances. Instead, you should create a queue by calling the queue method on a Crixa::Channel or Crixa::Exchange object. However, you need to know what parameters the constructor accepts.

  • name

    The name of the queue. If none is provided then RabbitMQ will auto-generate a name for you.

  • passive => $bool

    If this is true, then the constructor will throw an error unless the queue already exists.

    This defaults to false.

  • durable => $bool

    If this is true, then the queue will remain active across server restarts.

    This defaults to false.

  • auto_delete => $bool

    If this is true, then the queue will be deleted when there are no more consumers subscribed to it. The queue initially exists until at least one consumer subscribes.

    This defaults to false.

  • exclusive => $bool

    If this is true, then the queue is only accessible via the current connection and will be deleted when that connection closes.

    This defaults to false.

$queue->check_for_message(...)

This checks the queue for a message. This method does not block. It returns undef if there is no message ready. It accepts either a hash or hashref with the following keys:

no_ack => $bool

If this is true, then the message is not acknowledged as it is taken from the queue. You will need to explicitly acknowledge it using the ack method on the Crixa::Channel object from which the message came.

If this is false, then the message is acknowledged immediately. Calling the ack method later with this message's delivery tag will be an error.

This defaults to true.

$queue->wait_for_message(...)

This blocks until a message is ready. It always returns a single message.

This takes the same parameters as the check_for_message method.

$queue->handle_message($callback, ...)

This message takes a callback and blocks until the next message. It calls the callback with the message as its only argument and returns whatever the callback returns.

This takes the same parameters as the check_for_message method after the callback.

$queue->bind(...)

This binds a queue to an exchange. It accepts either a hash or hashref with the following keys:

  • exchange

    The name of the exchange to which the queue will be bound. This is required.

  • routing_key

    An optional routing key for the binding. If none is given the queue name is used instead.

  • headers

    An optional hashref used when binding to a headers matching exchange.

    This hashref should contain the headers against which the queue is matching.

    You can also specify an x-match key of either "any" or "all". If the value is "any" then the queue will receive a message when any of the headers in the message match those that the queue was bound with. if it is set to "all" then all headers in the message must match the binding.

$queue->delete(...)

This deletes the queue. It accepts either a hash or hashref with the following keys:

  • if_unused => $bool

    If this is true, then the queue is only deleted if it has no consumers. Given the way that Crixa handles getting messages, this is irrelevant if you are only using Crixa to communicate with the queue.

    This defaults to true.

  • if_empty => $bool

    If this is true, then the queue is only deleted if it is empty.

    This defaults to true.

$queue->name

Returns the queue name.

$queue->channel

Returns the Crixa::Channel that this queue uses.

$queue->passive

This returns the passive flag as passed to the constructor or set by a default.

$queue->durable

This returns the durable flag as passed to the constructor or set by a default.

$queue->auto_delete

This returns the auto-delete flag as passed to the constructor or set by a default.

$queue->exclusive

This returns the exclusive flag as passed to the constructor or set by a default.

AUTHORS

  • Chris Prather <chris@prather.org>

  • Dave Rolsky <autarch@urth.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2012 by Chris Prather.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.