arvicco-amqp 0.6.11 → 0.6.13

data/HISTORY

@@ -17,3 +17,11 @@
 == 0.6.11 / 2010-11-04
 
 * AMQP class behavior specified
+
+== 0.6.12 / 2010-11-04
+
+* MQ class methods specified
+
+== 0.6.13 / 2010-11-05
+
+* Secondary MQ instance methods specified

data/README.md

@@ -9,8 +9,13 @@ This library was tested primarily with RabbitMQ, although it should be compatibl
 server implementing the [AMQP 0-8 spec](http://www.amqp.org/confluence/download/attachments/720900/amqp0-8.pdf).
 
 
-This fork of AMQP contains following improvements:
---------------------------------------------------
+This fork of AMQP
+=================
+
+Intention is to describe AMQP lib behavior using RSpec, with reasonable level of completeness.
+Given a solid spec suite, it will be easier to expand the library going forward.
+
+Some improvements that are currently merged in, but not yet fully specified:
 
  * Support for setting extended headers in MQ::Exchange#publish. Particularly useful for :reply_to for RPC.
  * Multibyte character support (Ruby 1.9) in MQ::Exchange#publish.
@@ -18,7 +23,8 @@ This fork of AMQP contains following improvements:
  * MQ::Queue only wraps headers with new MQ::Headers if they are not nil. This allows pops to tell more easily when they've requested a message from an empty queue. See (https://github.com/tmm1/amqp/issues#issue/22)
  * Support for receiving Headers with zero-size data packets. Such contents with no body frames are totally legit if indicated header size is zero.
 
-TODO: * Support for AMQP::Protocol::Basic::Return method. See (https://github.com/tmm1/amqp/issues#issue/1).
+Some improvements that are planned:
+ * Support for AMQP::Protocol::Basic::Return method. See (https://github.com/tmm1/amqp/issues#issue/1).
 
 Getting started
 ===============

data/VERSION

@@ -1 +1 @@
-0.6.11
+0.6.13

data/lib/amqp/spec.rb

@@ -17,14 +17,14 @@ module AMQP
     end
 
     def self.Frame id
-      (@_base_frames ||= {})[id] ||= Class.new(Frame) do
+      (@_base_frames ||= {})[id] ||= Class.new(Frame) {
         class_eval %[
           def self.inherited klass
             klass.const_set(:ID, #{id})
             Frame.types[#{id}] = klass
           end
         ]
-      end
+      }
     end
 
     class Method    < Frame( 1 ); end

data/lib/mq.rb

@@ -148,6 +148,7 @@ class MQ
   end
 
   attr_reader :channel, :connection
+  alias :conn :connection
 
   # May raise a MQ::Error exception when the frame payload contains a
   # Protocol::Channel::Close object. 
@@ -243,6 +244,9 @@ class MQ
     end
   end
 
+  # Sends each argument through @connection, setting its *ticket* property to the @ticket
+  # received in most recent Protocol::Access::RequestOk. This operation is Mutex-synchronized.
+  #
   def send *args
     conn.callback { |c|
       (@_send_mutex ||= Mutex.new).synchronize do
@@ -677,10 +681,11 @@ class MQ
   # method it will raise a channel or connection exception.
   #
   def queue name, opts = {}
+    #noinspection RubyArgCount
     queues[name] ||= Queue.new(self, name, opts)
   end
 
-  # Takes a channel, queue and optional object.
+  # Takes a queue name and optional object.
   #
   # The optional object may be a class name, module name or object
   # instance. When given a class or module name, the object is instantiated
@@ -720,6 +725,9 @@ class MQ
     rpcs[name] ||= RPC.new(self, name, obj)
   end
 
+  # Schedules the request to close the channel to be sent. Actual closing of
+  # the channels happens when Protocol::Channel::CloseOk is received from broker.
+  #
   def close
     if @deferred_status == :succeeded
       send Protocol::Channel::Close.new(:reply_code => 200,
@@ -732,6 +740,7 @@ class MQ
   end
 
   # Define a message and callback block to be executed on all errors.
+  #
   def self.error msg = nil, &blk
     if blk
       @error_callback = blk
@@ -740,16 +749,19 @@ class MQ
     end
   end
 
-  def prefetch(size)
-    @prefetch_size = size
-    send Protocol::Basic::Qos.new(:prefetch_size => 0, :prefetch_count => size, :global => false)
+  # Asks the broker to set prefetch_count (size of the prefetch buffer) that the broker
+  # will maintain for outstanding unacknowledged messages on a this channel. This is
+  # Applications typically set the prefetch count to 1, which means the processing speed
+  # of the consumer exerts complete backpressure on the flow of messages in that channel.
+  #
+  def prefetch(count)
+    @prefetch_count = count
+    send Protocol::Basic::Qos.new(:prefetch_size => 0, :prefetch_count => count, :global => false)
     self
   end
 
-  # Asks the broker to redeliver all unacknowledged messages on this
-  # channel.
-  #
-  # * requeue (default false)
+  # Asks the broker to redeliver all unacknowledged messages on this channel.
+  # * :requeue - (default false)
   # If this parameter is false, the message will be redelivered to the original recipient.
   # If this flag is true, the server will attempt to requeue the message, potentially then
   # delivering it to an alternative subscriber.
@@ -773,6 +785,10 @@ class MQ
     @queues ||= {}
   end
 
+  # Yields a (Mutex-synchronized) FIFO queue of consumers that issued
+  # Protocol::Basic::Get requests (that is, called Queue#pop)
+  #
+  # Not typically called by client code.
   def get_queue
     if block_given?
       (@get_queue_mutex ||= Mutex.new).synchronize {
@@ -795,6 +811,8 @@ class MQ
     @consumers ||= {}
   end
 
+  # Resets and reinitializes the channel and its queues/exchanges
+  #
   def reset
     @deferred_status = nil
     @channel = nil
@@ -810,11 +828,13 @@ class MQ
     @queues = {}
     qus.each { |_, q| q.reset } if qus
 
-    prefetch(@prefetch_size) if @prefetch_size
+    prefetch(@prefetch_count) if @prefetch_count
   end
 
+  # Tests connection status of associated AMQP connection
+  #
   def connected?
-    connection.connected?
+    @connection.connected?
   end
 
   private
@@ -830,18 +850,20 @@ class MQ
   def log *args
     return unless MQ.logging
     pp args
-    puts
+    puts ''
   end
-
-  attr_reader :connection
-  alias :conn :connection
 end
 
 #-- convenience wrapper (read: HACK) for thread-local MQ object
 
 class MQ
+  # unique identifier
+  def MQ.id
+    Thread.current[:mq_id] ||= "#{`hostname`.strip}-#{Process.pid}-#{Thread.current.object_id}"
+  end
+
   def MQ.default
-    #-- XXX clear this when connection is closed
+    # TODO: clear this when connection is closed
     Thread.current[:mq] ||= MQ.new
   end
 
@@ -851,10 +873,3 @@ class MQ
     MQ.default.__send__(meth, *args, &blk)
   end
 end
-
-class MQ
-  # unique identifier
-  def MQ.id
-    Thread.current[:mq_id] ||= "#{`hostname`.strip}-#{Process.pid}-#{Thread.current.object_id}"
-  end
-end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: arvicco-amqp
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 29
   prerelease: false
   segments: 
   - 0
   - 6
-  - 11
-  version: 0.6.11
+  - 13
+  version: 0.6.13
 platform: ruby
 authors: 
 - Aman Gupta
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-04 00:00:00 +03:00
+date: 2010-11-05 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency