amqp 0.5.9 → 0.6.0

data/README

@@ -51,8 +51,8 @@ AMQP resources:
 
   Servers:
     RabbitMQ (Rabbit Technologies, Erlang/OTP, MPL) - http://rabbitmq.com
-    ZeroMQ   (iMatrix/FastMQ/Intel, C++, GPL3)      - http://www.zeromq.org
-    OpenAMQ  (iMatrix, C, GPL2)                     - http://openamq.org
+    ZeroMQ   (iMatix/FastMQ/Intel, C++, GPL3)       - http://www.zeromq.org
+    OpenAMQ  (iMatix, C, GPL2)                      - http://openamq.org
     ActiveMQ (Apache Foundation, Java, apache2)     - http://activemq.apache.org
 
   Steve Vinoski explains AMQP in his column, Towards Integration
@@ -67,8 +67,8 @@ AMQP resources:
   ZeroMQ's analysis of the messaging technology market
     http://www.zeromq.org/whitepapers:market-analysis
 
-  ZeroMQ's background to AMQP
-    http://www.zeromq.org/whitepapers:amqp-analysis
+  Pieter Hintjens's background to AMQP
+    http://www.openamq.org/doc:amqp-background
 
   Barry Pederson's py-amqplib
     http://barryp.org/software/py-amqplib/

data/examples/mq/logger.rb

@@ -13,8 +13,8 @@ EM.run{
       pp(msg)
       puts
     }
-    
-  else
+
+  elsif ARGV[0] == 'client'
 
     log = Logger.new
     log.debug 'its working!'
@@ -39,6 +39,16 @@ EM.run{
 
     AMQP.stop{ EM.stop_event_loop }
 
+  else
+
+    puts
+    puts "#{$0} <client|server>"
+    puts "  client: send logs to message queue"
+    puts "  server: read logs from message queue"
+    puts
+
+    EM.stop
+
   end
 }
 

data/examples/mq/simple-ack.rb

@@ -0,0 +1,46 @@
+$:.unshift File.dirname(__FILE__) + '/../../lib'
+require 'mq'
+require 'pp'
+
+# For ack to work appropriatly you must shutdown AMQP gracefully,
+# otherwise all items in your queue will be returned
+Signal.trap('INT') { AMQP.stop{ EM.stop } }
+Signal.trap('TERM'){ AMQP.stop{ EM.stop } }
+
+EM.run do
+  MQ.queue('awesome').publish('Totally rad 1')
+  MQ.queue('awesome').publish('Totally rad 2')
+  MQ.queue('awesome').publish('Totally rad 3')
+
+  i = 0
+
+  # Stopping after the second item was acked will keep the 3rd item in the queue
+  MQ.queue('awesome').subscribe(:ack => true) do |h,m|
+    if (i+=1) == 3
+      puts 'Shutting down...'
+      AMQP.stop{ EM.stop }
+    end
+
+    if AMQP.closing?
+      puts "#{m} (ignored, redelivered later)"
+    else
+      puts m
+      h.ack
+    end
+  end
+end
+
+__END__
+
+Totally rad 1
+Totally rad 2
+Shutting down...
+Totally rad 3 (ignored, redelivered later)
+
+When restarted:
+
+Totally rad 3
+Totally rad 1
+Shutting down...
+Totally rad 2 (ignored, redelivered later)
+Totally rad 3 (ignored, redelivered later)

data/examples/mq/simple-get.rb

@@ -0,0 +1,43 @@
+$:.unshift File.dirname(__FILE__) + '/../../lib'
+require 'mq'
+require 'pp'
+
+Signal.trap('INT') { AMQP.stop{ EM.stop } }
+Signal.trap('TERM'){ AMQP.stop{ EM.stop } }
+
+AMQP.start do
+  queue = MQ.queue('awesome')
+
+  queue.publish('Totally rad 1')
+  queue.publish('Totally rad 2')
+  EM.add_timer(5){ queue.publish('Totally rad 3') }
+
+  queue.pop{ |msg|
+    unless msg
+      # queue was empty
+      p [Time.now, :queue_empty!]
+
+      # try again in 1 second
+      EM.add_timer(1){ queue.pop }
+    else
+      # process this message
+      p [Time.now, msg]
+
+      # get the next message in the queue
+      queue.pop
+    end
+  }
+end
+
+__END__
+
+[Wed Oct 15 15:24:30 -0700 2008, "Totally rad 1"]
+[Wed Oct 15 15:24:30 -0700 2008, "Totally rad 2"]
+[Wed Oct 15 15:24:30 -0700 2008, :queue_empty!]
+[Wed Oct 15 15:24:31 -0700 2008, :queue_empty!]
+[Wed Oct 15 15:24:32 -0700 2008, :queue_empty!]
+[Wed Oct 15 15:24:33 -0700 2008, :queue_empty!]
+[Wed Oct 15 15:24:34 -0700 2008, :queue_empty!]
+[Wed Oct 15 15:24:35 -0700 2008, "Totally rad 3"]
+[Wed Oct 15 15:24:35 -0700 2008, :queue_empty!]
+[Wed Oct 15 15:24:36 -0700 2008, :queue_empty!]

data/examples/mq/simple.rb

@@ -5,7 +5,7 @@ require 'pp'
 EM.run do
 
   # connect to the amqp server
-  connection = AMQP.connect(:host => 'dev.rabbitmq.com', :logging => false)
+  connection = AMQP.connect(:host => 'localhost', :logging => false)
   
   # open a channel on the AMQP connection
   channel = MQ.new(connection)

data/lib/amqp.rb

@@ -14,7 +14,8 @@ module AMQP
   class << self
     @logging = false
     attr_accessor :logging
-    attr_reader :conn
+    attr_reader :conn, :closing
+    alias :closing? :closing
     alias :connection :conn
   end
 
@@ -41,24 +42,61 @@ module AMQP
     }
   end
 
-  def self.start *args
-    @conn ||= connect *args
+  # Must be called to startup the connection to the AMQP server.
+  #
+  # The method takes several arguments and an optional block.
+  #
+  # This takes any option that is also accepted by EventMachine::connect.
+  # Additionally, there are several AMQP-specific options.
+  #
+  # * :user => String (default 'guest')
+  # The username as defined by the AMQP server.
+  # * :pass => String (default 'guest')
+  # The password for the associated :user as defined by the AMQP server.
+  # * :vhost => String (default '/')
+  # The virtual host as defined by the AMQP server.
+  # * :timeout => Numeric (default nil)
+  # Measured in seconds.
+  # * :logging => true | false (default false)
+  # Toggle the extremely verbose logging of all protocol communications
+  # between the client and the server. Extremely useful for debugging.
+  #
+  #  AMQP.start do
+  #    # default is to connect to localhost:5672
+  #
+  #    # define queues, exchanges and bindings here.
+  #    # also define all subscriptions and/or publishers
+  #    # here.
+  #
+  #    # this block never exits unless EM.stop_event_loop
+  #    # is called.
+  #  end
+  #
+  # Most code will use the MQ api. Any calls to MQ.direct / MQ.fanout /
+  # MQ.topic / MQ.queue will implicitly call #start. In those cases,
+  # it is sufficient to put your code inside of an EventMachine.run
+  # block. See the code examples in MQ for details.
+  #
+  def self.start *args, &blk
+    EM.run{
+      @conn ||= connect *args
+      @conn.callback(&blk) if blk
+      @conn
+    }
+  end
+
+  class << self
+    alias :run :start
   end
   
   def self.stop
-    if @conn
+    if @conn and not @closing
+      @closing = true
       @conn.close{
         yield if block_given?
         @conn = nil
+        @closing = false
       }
     end
   end
-
-  def self.run *args
-    EM.run{
-      AMQP.start(*args).callback{
-        yield
-      }
-    }
-  end
-end
+end

data/lib/amqp/buffer.rb

@@ -1,5 +1,5 @@
 if [].map.respond_to? :with_index
-  class Array
+  class Array #:nodoc:
     def enum_with_index
       each.with_index
     end
@@ -9,9 +9,9 @@ else
 end
 
 module AMQP
-  class Buffer
-    class Overflow < Exception; end
-    class InvalidType < Exception; end
+  class Buffer #:nodoc: all
+    class Overflow < StandardError; end
+    class InvalidType < StandardError; end
     
     def initialize data = ''
       @data = data

data/lib/amqp/client.rb

@@ -1,7 +1,7 @@
 require 'amqp/frame'
 
 module AMQP
-  class Error < Exception; end
+  class Error < StandardError; end
 
   module BasicClient
     def process_frame frame
@@ -30,13 +30,14 @@ module AMQP
 
           send Protocol::Connection::Open.new(:virtual_host => @settings[:vhost],
                                               :capabilities => '',
-                                              :insist => false)
+                                              :insist => @settings[:insist])
 
         when Protocol::Connection::OpenOk
           succeed(self)
 
         when Protocol::Connection::Close
-          raise Error, "#{method.reply_text} in #{Protocol.classes[method.class_id].methods[method.method_id]}"
+          # raise Error, "#{method.reply_text} in #{Protocol.classes[method.class_id].methods[method.method_id]}"
+          STDERR.puts "#{method.reply_text} in #{Protocol.classes[method.class_id].methods[method.method_id]}"
 
         when Protocol::Connection::CloseOk
           @on_disconnect.call if @on_disconnect
@@ -61,7 +62,7 @@ module AMQP
       @settings = opts
       extend AMQP.client
 
-      @on_disconnect = proc{ raise Error, "Could not connect to server #{opts[:host]}:#{opts[:port]}" }
+      @on_disconnect ||= proc{ raise Error, "Could not connect to server #{opts[:host]}:#{opts[:port]}" }
 
       timeout @settings[:timeout] if @settings[:timeout]
       errback{ @on_disconnect.call }
@@ -69,7 +70,11 @@ module AMQP
 
     def connection_completed
       log 'connected'
-      @on_disconnect = proc{ raise Error, 'Disconnected from server' }
+      # @on_disconnect = proc{ raise Error, 'Disconnected from server' }
+      unless @closing
+        @on_disconnect = method(:reconnect)
+        @reconnecting = false
+      end
       @buf = Buffer.new
       send_data HEADER
       send_data [1, 1, VERSION_MAJOR, VERSION_MINOR].pack('C4')
@@ -77,7 +82,7 @@ module AMQP
 
     def unbind
       log 'disconnected'
-      @on_disconnect.call unless $!
+      EM.next_tick{ @on_disconnect.call }
     end
 
     def add_channel mq
@@ -115,13 +120,21 @@ module AMQP
       send_data data.to_s
     end
 
+    #:stopdoc:
     # def send_data data
     #   log 'send_data', data
     #   super
     # end
+    #:startdoc:
 
     def close &on_disconnect
-      @on_disconnect = on_disconnect if on_disconnect
+      if on_disconnect
+        @closing = true
+        @on_disconnect = proc{
+          on_disconnect.call
+          @closing = false
+        }
+      end
 
       callback{ |c|
         if c.channels.any?
@@ -136,7 +149,29 @@ module AMQP
         end
       }
     end
-  
+
+    def reconnect force = false
+      if @reconnecting and not force
+        # wait 1 second after first reconnect attempt, in between each subsequent attempt
+        EM.add_timer(1){ reconnect(true) }
+        return
+      end
+
+      unless @reconnecting
+        @deferred_status = nil
+        initialize(@settings)
+
+        mqs = @channels
+        @channels = {}
+        mqs.each{ |_,mq| mq.reset } if mqs
+
+        @reconnecting = true
+      end
+
+      log 'reconnecting'
+      EM.reconnect @settings[:host], @settings[:port], self
+    end
+
     def self.connect opts = {}
       opts = AMQP.settings.merge(opts)
       EM.connect opts[:host], opts[:port], self, opts

data/lib/amqp/frame.rb

@@ -3,7 +3,7 @@ require 'amqp/buffer'
 require 'amqp/protocol'
 
 module AMQP
-  class Frame
+  class Frame #:nodoc: all
     def initialize payload = nil, channel = 0
       @channel, @payload = channel, payload
     end
@@ -33,7 +33,7 @@ module AMQP
       end
     end
     
-    class Invalid < Exception; end
+    class Invalid < StandardError; end
     
     class Method
       def initialize payload = nil, channel = 0

data/lib/amqp/protocol.rb

@@ -3,6 +3,7 @@ require 'amqp/buffer'
 
 module AMQP
   module Protocol
+    #:stopdoc:
     class Class::Method
       def initialize *args
         opts = args.pop if args.last.is_a? Hash
@@ -64,6 +65,29 @@ module AMQP
       end
     end
 
+    #:startdoc:
+    #
+    # Contains a properties hash that holds some potentially interesting 
+    # information.
+    # * :delivery_mode
+    # 1 equals transient.
+    # 2 equals persistent. Unconsumed persistent messages will survive
+    # a server restart when they are stored in a durable queue.
+    # * :redelivered
+    # True or False
+    # * :routing_key
+    # The routing string used for matching this message to this queue.
+    # * :priority
+    # An integer in the range of 0 to 9 inclusive.
+    # * :content_type
+    # Always "application/octet-stream" (byte stream)
+    # * :exchange
+    # The source exchange which published this message.
+    # * :message_count
+    # The number of unconsumed messages contained in the queue.
+    # * :delivery_tag
+    # A monotonically increasing integer. This number should not be trusted
+    # as a sequence number. There is no guarantee it won't get reset.
     class Header
       def initialize *args
         opts = args.pop if args.last.is_a? Hash
@@ -132,6 +156,7 @@ module AMQP
       class_id, method_id = buf.read(:short, :short)
       classes[class_id].methods[method_id].new(buf)
     end
+    #:stopdoc:
   end
 end
 

data/lib/amqp/spec.rb

@@ -1,6 +1,7 @@
 
-# this file was autogenerated on Fri Aug 01 15:08:30 -0700 2008
-# using amqp-0.8.json    (mtime: Fri Aug 01 15:08:22 -0700 2008)
+#:stopdoc:
+# this file was autogenerated on Sat Jan 03 14:05:57 -0600 2009
+# using amqp-0.8.json    (mtime: Sat Jan 03 08:58:13 -0600 2009)
 #
 # DO NOT EDIT! (edit protocol/codegen.rb instead, and run `rake codegen`)
 

data/lib/ext/blankslate.rb

@@ -1,7 +1,7 @@
 unless defined?(BlankSlate)
   class BlankSlate < BasicObject; end if defined?(BasicObject)
 
-  class BlankSlate
+  class BlankSlate #:nodoc:
     instance_methods.each { |m| undef_method m unless m =~ /^__/ }
   end
 end