bunny for rabbitmq

http://rdoc.info/github/ruby-amqp/bunny/Bunny/Queue

 

Class: Bunny::Queue

Inherits:

Object show all

Defined in:

lib/bunny/queue.rb

Overview

Represents AMQP 0.9.1 queue.

See Also:

• Queues and Consumers guide
• RabbitMQ Extensions guide

Instance Attribute Summary (collapse)

• - (Bunny::Channel) channel readonly

  Channel this queue uses.

• - (String) name readonly

  Queue name.

• - (Hash) options readonly

  Options this queue was created with.

Instance Method Summary (collapse)

• - (Hash) arguments

  Additional optional arguments (typically used by RabbitMQ extensions and plugins).

• - (Boolean) auto_delete?

  True if this queue was declared as automatically deleted (deleted as soon as last consumer unbinds).

• - (Object) bind(exchange, opts = {})

  Binds queue to an exchange.

• - (Integer) consumer_count

  How many active consumers the queue has.

• - (Object) delete(opts = {})

  Deletes the queue.

• - (Boolean) durable?

  True if this queue was declared as durable (will survive broker restart).

• - (Boolean) exclusive?

  True if this queue was declared as exclusive (limited to just one consumer).

• - (Queue) initialize(channel_or_connection, name = AMQ::Protocol::EMPTY_STRING, opts = {}) constructor

  A new instance of Queue.

• - (Integer) message_count

  How many messages the queue has ready (e.g. not delivered but not unacknowledged).

• - (Array) pop(opts = {:manual_ack => false}, &block) (also: #get)

  Triple of delivery info, message properties and message content.

• - (Object) publish(payload, opts = {})

  Publishes a message to the queue via default exchange.

• - (Object) purge(opts = {})

  Purges a queue (removes all messages from it).

• - (Boolean) server_named?

  True if this queue was declared as server named.

• - (Hash) status

  A hash with information about the number of queue messages and consumers.

• - (Object) subscribe(opts = { :consumer_tag => @channel.generate_consumer_tag, :manual_ack => false, :exclusive => false, :block => false, :on_cancellation => nil }, &block)

  Adds a consumer to the queue (subscribes for message deliveries).

• - (Object) subscribe_with(consumer, opts = {:block => false})

  Adds a consumer object to the queue (subscribes for message deliveries).

• - (Object) unbind(exchange, opts = {})

  Unbinds queue from an exchange.

Constructor Details

permalink - (Queue) initialize(channel_or_connection, name = AMQ::Protocol::EMPTY_STRING, opts = {})

Returns a new instance of Queue

Options Hash (opts):

• :durable (Boolean) — default: false —

  Should this queue be durable?

• :auto_delete (Boolean) — default: false —

  Should this queue be automatically deleted when the last consumer disconnects?

• :exclusive (Boolean) — default: false —

  Should this queue be exclusive (only can be used by this connection, removed when the connection is closed)?

• :arguments (Boolean) — default: {} —

  Additional optional arguments (typically used by RabbitMQ extensions and plugins)

See Also:

• Channel#queue
• Queues and Consumers guide
• RabbitMQ Extensions guide

[View source] [View on GitHub]

Instance Attribute Details

permalink - (Bunny::Channel) channel (readonly)

[View on GitHub]

permalink - (String) name (readonly)

[View on GitHub]

permalink - (Hash) options (readonly)

[View on GitHub]

Instance Method Details

permalink - (Hash) arguments

Returns Additional optional arguments (typically used by RabbitMQ extensions and plugins)

 

[View source] [View on GitHub]

- (Boolean) auto_delete?

Returns true if this queue was declared as automatically deleted (deleted as soon as last consumer unbinds).

See Also:

• Queues and Consumers guide

[View source] [View on GitHub]

permalink - (Object) bind(exchange, opts = {})

Binds queue to an exchange

Options Hash (opts):

• :routing_key (String) —

  Routing key

• :arguments (Hash) — default: {} —

  Additional optional binding arguments

See Also:

• Queues and Consumers guide
• Bindings guide

[View source] [View on GitHub]

permalink - (Integer) consumer_count

[View source] [View on GitHub]

permalink - (Object) delete(opts = {})

Deletes the queue

Options Hash (opts):

• if_unused (Boolean) — default: false —

  Should this queue be deleted only if it has no consumers?

• if_empty (Boolean) — default: false —

  Should this queue be deleted only if it has no messages?

See Also:

• Queues and Consumers guide

[View source] [View on GitHub]

- (Boolean) durable?

Returns true if this queue was declared as durable (will survive broker restart).

See Also:

• Queues and Consumers guide

[View source] [View on GitHub]

- (Boolean) exclusive?

Returns true if this queue was declared as exclusive (limited to just one consumer)

See Also:

• Queues and Consumers guide

[View source] [View on GitHub]

permalink - (Integer) message_count

[View source] [View on GitHub]

permalink - (Array) pop(opts = {:manual_ack => false}, &block) Also known as: get

Returns Triple of delivery info, message properties and message content. If the queue is empty, all three will be nils.

Examples:

conn = Bunny.new
conn.start

ch   = conn.create_channel
q = ch.queue("test1")
x = ch.default_exchange
x.publish("Hello, everybody!", :routing_key => 'test1')

delivery_info, properties, payload = q.pop

puts "This is the message: " + payload + "\n\n"
conn.close

Options Hash (opts):

• :ack (Boolean) — default: false —

  [DEPRECATED] Use :manual_ack instead

• :manual_ack (Boolean) — default: false —

  Will the message be acknowledged manually?

See Also:

• Queues and Consumers guide
• #subscribe

[View source] [View on GitHub]

permalink - (Object) publish(payload, opts = {})

Publishes a message to the queue via default exchange. Takes the same arguments as Exchange#publish

See Also:

• Exchange#publish
• Channel#default_exchange
• Exchanges and Publishing guide

[View source] [View on GitHub]

permalink - (Object) purge(opts = {})

Purges a queue (removes all messages from it)

See Also:

• Queues and Consumers guide

[View source] [View on GitHub]

- (Boolean) server_named?

Returns true if this queue was declared as server named.

See Also:

• Queues and Consumers guide

[View source] [View on GitHub]

permalink - (Hash) status

Returns A hash with information about the number of queue messages and consumers

See Also:

• #message_count
• #consumer_count

[View source] [View on GitHub]

permalink - (Object) subscribe(opts = { :consumer_tag => @channel.generate_consumer_tag, :manual_ack => false, :exclusive => false, :block => false, :on_cancellation => nil }, &block)

Adds a consumer to the queue (subscribes for message deliveries).

Options Hash (opts):

• :ack (Boolean) — default: false —

  [DEPRECATED] Use :manual_ack instead

• :manual_ack (Boolean) — default: false —

  Will this consumer use manual acknowledgements?

• :exclusive (Boolean) — default: false —

  Should this consumer be exclusive for this queue?

• :block (Boolean) — default: false —

  Should the call block calling thread?

• :on_cancellation (#call) —

  Block to execute when this consumer is cancelled remotely (e.g. via the RabbitMQ Management plugin)

• :consumer_tag (String) —

  Unique consumer identifier. It is usually recommended to let Bunny generate it for you.

• :arguments (Hash) — default: {} —

  Additional (optional) arguments, typically used by RabbitMQ extensions

See Also:

• Queues and Consumers guide

[View source] [View on GitHub]

permalink - (Object) subscribe_with(consumer, opts = {:block => false})

Adds a consumer object to the queue (subscribes for message deliveries).

Options Hash (opts):

• block (Boolean) — default: false —

  Should the call block calling thread?

See Also:

• Queues and Consumers guide

[View source] [View on GitHub]

permalink - (Object) unbind(exchange, opts = {})

Unbinds queue from an exchange

Options Hash (opts):

• :routing_key (String) —

  Routing key

• :arguments (Hash) — default: {} —

  Additional optional binding arguments

See Also:

• Queues and Consumers guide
• Bindings guide