bunny 0.9.0.pre12 → 0.9.0.pre13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ee7de4a1d5a24771bf6fe5f7e070c6d6afd6340
-  data.tar.gz: 3068de841ec8bbe3368b695866430a8f3859cf5a
+  metadata.gz: b138bcc7caf170e8104ab84dcf9dc4ae89387efa
+  data.tar.gz: e379d87d1c0fa62e5c84908f530d8160328873cf
 SHA512:
-  metadata.gz: 8ebc06c578c1ef13ac197f44aac01f38ca469bccada8f500aaeb80a3b3e3320ce19588cdfce825b1b669e4eef48305b1d169bae22ffb94208ed25828fe4a8786
-  data.tar.gz: 27bf9c563f423846c0cb3402779a043b2faf8b83a82099c8b5868934a8bff0b1b3164149b3b9c2a762a41b4f1d6b6fb66c6fcf560ba5b0ad9d10ee4b3520ff34
+  metadata.gz: f850913f5f76996a6f333ff5bc2a945506c99b1463999b2f912a1602d7f96ff293285d26beb48ddf99cba314f69c6910d38e23858408c11d39a18dc821583dff
+  data.tar.gz: a12db3df3ad28867e4af5268e5a8f623884649cddc2259ceef6fadbd716099fc7928712857ababe86ad4e336406ea0d3672f8b8d0dd2dab4547475feccf5a41b

data/ChangeLog.md

@@ -1,3 +1,35 @@
+## Changes between Bunny 0.9.0.pre12 and 0.9.0.pre13
+
+### Channels Without Consumers Now Tear Down Consumer Pools
+
+Channels without consumers left (when all consumers were cancelled)
+will now tear down their consumer work thread pools, thus making
+`HotBunnies::Queue#subscribe(:block => true)` calls unblock.
+
+This is typically the desired behavior.
+
+### Consumer and Channel Available In Delivery Handlers
+
+Delivery handlers registered via `Bunny::Queue#subscribe` now will have
+access to the consumer and channel they are associated with via the
+`delivery_info` argument:
+
+``` ruby
+q.subscribe do |delivery_info, properties, payload|
+  delivery_info.consumer # => the consumer this delivery is for
+  delivery_info.consumer # => the channel this delivery is on
+end
+```
+
+This allows using `Bunny::Queue#subscribe` for one-off consumers
+much easier, including when used with the `:block` option.
+
+### Bunny::Exchange#wait_for_confirms
+
+`Bunny::Exchange#wait_for_confirms` is a convenience method on `Bunny::Exchange` that
+delegates to the method with the same name on exchange's channel.
+
+
 ## Changes between Bunny 0.9.0.pre11 and 0.9.0.pre12
 
 ### Ruby 1.8 Compatibility Regression Fix

data/examples/guides/queues/one_off_consumer.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require "rubygems"
+require "bunny"
+
+conn = Bunny.new
+conn.start
+
+ch = conn.create_channel
+q  = ch.queue("bunny.examples.hello_world", :auto_delete => true)
+
+q.publish("Hello!", :routing_key => q.name)
+
+# demonstrates a blocking consumer that needs to cancel itself
+# in the message handler
+q.subscribe(:block => true) do |delivery_info, properties, payload|
+  puts "Received #{payload}, cancelling"
+  delivery_info.consumer.cancel
+end
+
+sleep 1.0
+conn.close

data/lib/bunny/channel.rb

@@ -18,7 +18,7 @@ else
 end
 
 module Bunny
-  # ## What are AMQP channels
+  # ## Channels in RabbitMQ
   #
   # To quote {http://www.rabbitmq.com/resources/specs/amqp0-9-1.pdf AMQP 0.9.1 specification}:
   #
@@ -41,7 +41,7 @@ module Bunny
   #
   #   ch   = conn.create_channel
   #
-  # This will automatically allocate channel id.
+  # This will automatically allocate a channel id.
   #
   # @example Instantiating
   #
@@ -806,9 +806,18 @@ module Bunny
                                                                   false,
                                                                   arguments))
 
-      Bunny::Timer.timeout(read_write_timeout, ClientTimeout) do
-        @last_basic_consume_ok = wait_on_continuations
+      begin
+        Bunny::Timer.timeout(read_write_timeout, ClientTimeout) do
+          @last_basic_consume_ok = wait_on_continuations
+        end
+      rescue Exception => e
+        # if basic.consume-ok never arrives, unregister the proactively
+        # registered consumer. MK.
+        unregister_consumer(@last_basic_consume_ok.consumer_tag)
+
+        raise e
       end
+
       # covers server-generated consumer tags
       add_consumer(queue_name, @last_basic_consume_ok.consumer_tag, no_ack, exclusive, arguments, &block)
 
@@ -827,6 +836,12 @@ module Bunny
       raise_if_no_longer_open!
       maybe_start_consumer_work_pool!
 
+      # helps avoid race condition between basic.consume-ok and basic.deliver if there are messages
+      # in the queue already. MK.
+      if consumer.consumer_tag && consumer.consumer_tag.strip != AMQ::Protocol::EMPTY_STRING
+        register_consumer(consumer.consumer_tag, consumer)
+      end
+
       @connection.send_frame(AMQ::Protocol::Basic::Consume.encode(@id,
                                                                   consumer.queue_name,
                                                                   consumer.consumer_tag,
@@ -836,15 +851,18 @@ module Bunny
                                                                   false,
                                                                   consumer.arguments))
 
-      # helps avoid race condition between basic.consume-ok and basic.deliver if there are messages
-      # in the queue already. MK.
-      if consumer.consumer_tag && consumer.consumer_tag.strip != AMQ::Protocol::EMPTY_STRING
-        register_consumer(consumer.consumer_tag, consumer)
-      end
+      begin
+        Bunny::Timer.timeout(read_write_timeout, ClientTimeout) do
+          @last_basic_consume_ok = wait_on_continuations
+        end
+      rescue Exception => e
+        # if basic.consume-ok never arrives, unregister the proactively
+        # registered consumer. MK.
+        unregister_consumer(@last_basic_consume_ok.consumer_tag)
 
-      Bunny::Timer.timeout(read_write_timeout, ClientTimeout) do
-        @last_basic_consume_ok = wait_on_continuations
+        raise e
       end
+
       # covers server-generated consumer tags
       register_consumer(@last_basic_consume_ok.consumer_tag, consumer)
 
@@ -868,9 +886,17 @@ module Bunny
         @last_basic_cancel_ok = wait_on_continuations
       end
 
+      maybe_kill_consumer_work_pool! unless any_consumers?
+
       @last_basic_cancel_ok
     end
 
+    # @return [Boolean] true if there are consumers on this channel
+    # @api public
+    def any_consumers?
+      @consumer_mutex.synchronize { @consumers.any? }
+    end
+
     # @endgroup
 
 
@@ -1417,6 +1443,11 @@ module Bunny
     # @endgroup
 
 
+    def to_s
+      "#<#{self.class.name}:#{object_id} @id=#{self.number} @connection=#{@connection.to_s}>"
+    end
+
+
     #
     # Implementation
     #
@@ -1428,6 +1459,13 @@ module Bunny
       end
     end
 
+    # @private
+    def unregister_consumer(consumer_tag)
+      @consumer_mutex.synchronize do
+        @consumers.delete(consumer_tag)
+      end
+    end
+
     # @private
     def add_consumer(queue, consumer_tag, no_ack, exclusive, arguments, &block)
       @consumer_mutex.synchronize do
@@ -1475,7 +1513,7 @@ module Bunny
         @consumers.delete(method.consumer_tag)
       when AMQ::Protocol::Basic::CancelOk then
         @continuations.push(method)
-        @consumers.delete(method.consumer_tag)
+        unregister_consumer(method.consumer_tag)
       when AMQ::Protocol::Tx::SelectOk, AMQ::Protocol::Tx::CommitOk, AMQ::Protocol::Tx::RollbackOk then
         @continuations.push(method)
       when AMQ::Protocol::Tx::SelectOk then
@@ -1525,7 +1563,7 @@ module Bunny
       consumer = @consumers[basic_deliver.consumer_tag]
       if consumer
         @work_pool.submit do
-          consumer.call(DeliveryInfo.new(basic_deliver), MessageProperties.new(properties), content)
+          consumer.call(DeliveryInfo.new(basic_deliver, consumer, self), MessageProperties.new(properties), content)
         end
       else
         @logger.warn "No consumer for tag #{basic_deliver.consumer_tag} on channel #{@id}!"

data/lib/bunny/consumer.rb

@@ -83,6 +83,10 @@ module Bunny
       "#<#{self.class.name}:#{object_id} @channel_id=#{@channel.number} @queue=#{self.queue_name}> @consumer_tag=#{@consumer_tag} @exclusive=#{@exclusive} @no_ack=#{@no_ack}>"
     end
 
+    def to_s
+      "#<#{self.class.name}:#{object_id} @channel_id=#{@channel.number} @queue=#{self.queue_name}> @consumer_tag=#{@consumer_tag}>"
+    end
+
     #
     # Recovery
     #

data/lib/bunny/delivery_info.rb

@@ -14,15 +14,21 @@ module Bunny
     # API
     #
 
-    def initialize(basic_deliver)
+    attr_reader :consumer, :channel
+
+    def initialize(basic_deliver, consumer, channel)
       @basic_deliver = basic_deliver
       @hash          = {
         :consumer_tag => basic_deliver.consumer_tag,
         :delivery_tag => basic_deliver.delivery_tag,
         :redelivered  => basic_deliver.redelivered,
         :exchange     => basic_deliver.exchange,
-        :routing_key  => basic_deliver.routing_key
+        :routing_key  => basic_deliver.routing_key,
+        :consumer     => consumer,
+        :channel      => channel
       }
+      @consumer      = consumer
+      @channel       = channel
     end
 
     def each(*args, &block)

data/lib/bunny/exceptions.rb

@@ -70,7 +70,7 @@ module Bunny
       @username = username
       @vhost    = vhost
 
-      super("AMQP broker closed TCP connection before authentication succeeded: this usually means authentication failure due to misconfiguration or that RabbitMQ version does not support AMQP 0.9.1. Please check your configuration. Username: #{username}, vhost: #{vhost}, password length: #{password_length}")
+      super("RabbitMQ closed TCP connection before authentication succeeded: this usually means authentication failure due to misconfiguration or that RabbitMQ version does not support AMQP 0.9.1. Please check your configuration. Username: #{username}, vhost: #{vhost}, password length: #{password_length}")
     end # initialize(settings)
   end # PossibleAuthenticationFailureError
 

data/lib/bunny/exchange.rb

@@ -196,12 +196,23 @@ module Bunny
 
     # Defines a block that will handle returned messages
     # @see http://rubybunny.info/articles/exchanges.html
+    # @api public
     def on_return(&block)
       @on_return = block
 
       self
     end
 
+    # Waits until all outstanding publisher confirms on the channel
+    # arrive.
+    #
+    # This is a convenience method that delegates to {Bunny::Channel#wait_for_confirms}
+    #
+    # @api public
+    def wait_for_confirms
+      @channel.wait_for_confirms
+    end
+
     # @private
     def recover_from_network_failure
       # puts "Recovering exchange #{@name} from network failure"

data/lib/bunny/session.rb

@@ -648,7 +648,7 @@ module Bunny
     # @return [String]
     # @api public
     def to_s
-      "Bunny::Session #{@user}@#{@host}:#{@port}, vhost=#{@vhost}"
+      "#<#{self.class.name}:#{object_id} #{@user}@#{@host}:#{@port}, vhost=#{@vhost}>"
     end
 
     protected

data/lib/bunny/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Bunny
-  VERSION = "0.9.0.pre12"
+  VERSION = "0.9.0.pre13"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bunny
 version: !ruby/object:Gem::Version
-  version: 0.9.0.pre12
+  version: 0.9.0.pre13
 platform: ruby
 authors:
 - Chris Duncan
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-17 00:00:00.000000000 Z
+date: 2013-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amq-protocol
@@ -86,6 +86,7 @@ files:
 - examples/guides/getting_started/blabbr.rb
 - examples/guides/getting_started/hello_world.rb
 - examples/guides/getting_started/weathr.rb
+- examples/guides/queues/one_off_consumer.rb
 - examples/guides/queues/redeliveries.rb
 - lib/bunny.rb
 - lib/bunny/authentication/credentials_encoder.rb