amq-client 0.7.0.alpha5 → 0.7.0.alpha6

data/Gemfile

@@ -13,7 +13,7 @@ def custom_gem(name, options = Hash.new)
   end
 end
 
-gem "eventmachine"
+custom_gem "eventmachine"
 # cool.io uses iobuffer that won't compile on JRuby
 # (and, probably, Windows)
 gem "cool.io", :platform => :ruby

data/examples/eventmachine_adapter/connection_failure_callback.rb

@@ -19,7 +19,7 @@ EM.run do
                                           :vhost    => "/amq_client_testbed",
                                           :user     => "amq_client_gem",
                                           :password => "amq_client_gem_password",
-                                          :connection_timeout        => 0.3,
+                                          :timeout        => 0.3,
                                           :on_tcp_connection_failure => Proc.new { |settings| puts "Failed to connect, as expected"; EM.stop }) do |client|
     raise "Connected, authenticated. This is not what this example is supposed to do!"
   end

data/examples/eventmachine_adapter/connection_failure_exception.rb

@@ -20,7 +20,7 @@ begin
                                             :vhost    => "/amq_client_testbed",
                                             :user     => "amq_client_gem",
                                             :password => "amq_client_gem_password",
-                                            :connection_timeout        => 0.3) do |client|
+                                            :timeout        => 0.3) do |client|
       raise "Connected, authenticated. This is not what this example is supposed to do!"
     end
   end

data/examples/eventmachine_adapter/connection_loss_handler.rb

@@ -17,7 +17,7 @@ EM.run do
                                           :vhost    => "/amq_client_testbed",
                                           :user     => "amq_client_gem",
                                           :password => "amq_client_gem_password",
-                                          :connection_timeout        => 0.3,
+                                          :timeout        => 0.3,
                                           :on_tcp_connection_failure => Proc.new { |settings| puts "Failed to connect, this was NOT expected"; EM.stop }) do |client|
 
     client.on_tcp_connection_loss do |cl, settings|

data/lib/amq/client/adapters/event_machine.rb

@@ -7,7 +7,7 @@ require "amq/client/framing/string/frame"
 module AMQ
   module Client
     class EventMachineClient < EM::Connection
-
+      # @private
       class Deferrable
         include EventMachine::Deferrable
       end
@@ -25,15 +25,19 @@ module AMQ
       #
 
       def self.connect(settings = nil, &block)
-        @settings = settings = Settings.configure(settings)
+        @settings = Settings.configure(settings)
 
-        instance = EventMachine.connect(settings[:host], settings[:port], self, settings)
+        instance = EventMachine.connect(@settings[:host], @settings[:port], self, @settings)
         instance.register_connection_callback(&block)
 
         instance
       end
 
-
+      # Reconnect after a period of wait.
+      #
+      # @param [Fixnum]  period Period of time, in seconds, to wait before reconnection attempt.
+      # @param [Boolean] force  If true, enforces immediate reconnection.
+      # @api public
       def reconnect(period = 5, force = false)
         if @reconnecting and not force
           EventMachine::Timer.new(period) {
@@ -51,12 +55,15 @@ module AMQ
         self.reconnect(@settings[:host], @settings[:port])
       end
 
-
+      # For EventMachine adapter, this is a no-op.
+      # @api public
       def establish_connection(settings)
         # Unfortunately there doesn't seem to be any sane way
         # how to get EventMachine connect to the instance level.
       end
 
+      # @see #on_connection
+      # @private
       def register_connection_callback(&block)
         unless block.nil?
           # delay calling block we were given till after we receive
@@ -91,6 +98,8 @@ module AMQ
 
         self.reset
 
+        self.set_pending_connect_timeout((@settings[:timeout] || 3).to_f)
+
         if self.heartbeat_interval > 0
           @last_server_heartbeat = Time.now
           EventMachine.add_periodic_timer(self.heartbeat_interval, &method(:send_heartbeat))
@@ -100,11 +109,18 @@ module AMQ
 
       alias send_raw send_data
 
-
+      # Whether we are in authentication state (after TCP connection was estabilished
+      # but before broker authenticated us).
+      #
+      # @return [Boolean]
+      # @api public
       def authenticating?
         @authenticating
       end # authenticating?
 
+      # IS TCP connection estabilished and currently active?
+      # @return [Boolean]
+      # @api public
       def tcp_connection_established?
         @tcp_connection_established
       end # tcp_connection_established?
@@ -116,6 +132,7 @@ module AMQ
       # EventMachine reactor callback. Is run when TCP connection is estabilished
       # but before resumption of the network loop. Note that this includes cases
       # when TCP connection has failed.
+      # @private
       def post_init
         reset
 
@@ -131,6 +148,7 @@ module AMQ
       end # post_init
 
       # Called by EventMachine reactor once TCP connection is successfully estabilished.
+      # @private
       def connection_completed
         # we only can safely set this value here because EventMachine is a lovely piece of
         # software that calls #post_init before #unbind even when TCP connection
@@ -146,6 +164,7 @@ module AMQ
         self.handshake
       end
 
+      # @private
       def close_connection(*args)
         @intentionally_closing_connection = true
 
@@ -158,7 +177,8 @@ module AMQ
       # * Our peer closes TCP connection down
       # * There is a network connection issue
       # * Initial TCP connection fails
-      def unbind
+      # @private
+      def unbind(exception = nil)
         if !@tcp_connection_established && !@had_successfull_connected_before
           @tcp_connection_failed = true
           self.tcp_connection_failed
@@ -193,6 +213,7 @@ module AMQ
       # EventMachine receives data in chunks, sometimes those chunks are smaller
       # than the size of AMQP frame. That's why you need to add some kind of buffer.
       #
+      # @private
       def receive_data(chunk)
         @chunk_buffer << chunk
         while frame = get_next_frame

data/lib/amq/client/connection.rb

@@ -83,7 +83,7 @@ module AMQ
 
 
 
-
+      # @api public
       def initialize(client, mechanism, response, locale, client_properties = nil)
         @mechanism         = mechanism
         @response          = response
@@ -111,7 +111,7 @@ module AMQ
         self.define_callback(:close) { |exception| raise(exception) }
       end
 
-
+      # @api public
       def settings
         @client.settings
       end # settings
@@ -124,6 +124,7 @@ module AMQ
 
       # Sends connection.open to the server.
       #
+      # @api public
       # @see http://bit.ly/htCzCX AMQP 0.9.1 protocol documentation (Section 1.4.2.7)
       def open(vhost = "/")
         @client.send Protocol::Connection::Open.encode(vhost)
@@ -132,13 +133,14 @@ module AMQ
 
       # Sends connection.close to the server.
       #
+      # @api public
       # @see http://bit.ly/htCzCX AMQP 0.9.1 protocol documentation (Section 1.4.2.9)
       def close(reply_code = 200, reply_text = "Goodbye", class_id = 0, method_id = 0)
         @client.send Protocol::Connection::Close.encode(reply_code, reply_text, class_id, method_id)
         closing!
       end
 
-
+      # @api public
       def reset_state!
       end # reset_state!
 
@@ -149,22 +151,25 @@ module AMQ
       #
 
 
-      # Handles connection.open
+      # Handles Connection.Start.
       #
+      # @api plugin
       # @see http://bit.ly/htCzCX AMQP 0.9.1 protocol documentation (Section 1.4.2.1.)
       def start_ok(method)
         @server_properties = method.server_properties
 
-        # it's not clear whether we should transition to :opening state here
+        # It's not clear whether we should transition to :opening state here
         # or in #open but in case authentication fails, it would be strange to have
         # @status undefined. So lets do this. MK.
         opening!
+
         @client.send Protocol::Connection::StartOk.encode(@client_properties, @mechanism, @response, @locale)
       end
 
 
-      # Handles connection.open-Ok
+      # Handles Connection.Open-Ok.
       #
+      # @api plugin
       # @see http://bit.ly/htCzCX AMQP 0.9.1 protocol documentation (Section 1.4.2.8.)
       def handle_open_ok(method)
         @known_hosts = method.known_hosts
@@ -175,8 +180,9 @@ module AMQ
         @client.connection_successful if @client.respond_to?(:connection_successful)
       end
 
-      # Handles connection.tune-ok
+      # Handles Connection.Tune-Ok.
       #
+      # @api plugin
       # @see http://bit.ly/htCzCX AMQP 0.9.1 protocol documentation (Section 1.4.2.6)
       def handle_tune(method)
         @channel_max        = method.channel_max
@@ -187,27 +193,29 @@ module AMQ
       end # handle_tune(method)
 
 
-      # Handles connection.close
+      # Handles Connection.Close.
       #
+      # @api plugin
       # @see http://bit.ly/htCzCX AMQP 0.9.1 protocol documentation (Section 1.5.2.9)
       def handle_close(method)
         self.handle_connection_interruption
 
         closed!
         # TODO: use proper exception class, provide protocol class (we know method.class_id and method.method_id) as well!
-        x = RuntimeError.new(method.reply_text)
-        self.error(x)
+        error = RuntimeError.new(method.reply_text)
+        self.error(error)
       end
 
-      # Handles connection.close-ok
+      # Handles Connection.Close-Ok.
       #
+      # @api plugin
       # @see http://bit.ly/htCzCX AMQP 0.9.1 protocol documentation (Section 1.4.2.10)
       def handle_close_ok(method)
         closed!
         @client.disconnection_successful
       end # handle_close_ok(method)
 
-
+      # @api plugin
       def handle_connection_interruption
         @channels.each { |n, c| c.handle_connection_interruption }
       end # handle_connection_interruption

data/lib/amq/client/version.rb

@@ -1,5 +1,5 @@
 module AMQ
   module Client
-    VERSION = "0.7.0.alpha5"
+    VERSION = "0.7.0.alpha6"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amq-client
 version: !ruby/object:Gem::Version
-  version: 0.7.0.alpha5
+  version: 0.7.0.alpha6
   prerelease: 6
 platform: ruby
 authors:
@@ -12,12 +12,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: 
-date: 2011-04-21 00:00:00.000000000 +04:00
+date: 2011-04-22 00:00:00.000000000 +04:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &2155923140 !ruby/object:Gem::Requirement
+  requirement: &2152430260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -25,10 +25,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2155923140
+  version_requirements: *2152430260
 - !ruby/object:Gem::Dependency
   name: amq-protocol
-  requirement: &2164651300 !ruby/object:Gem::Requirement
+  requirement: &2152682300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -36,7 +36,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2164651300
+  version_requirements: *2152682300
 description: amq-client supports multiple networking adapters (EventMachine, TCP sockets,
   cool.io) and supposed to back more opinionated AMQP clients (such as amqp gem, bunny,
   et cetera) or be used directly in cases when access to more advanced AMQP 0.9.1