bunny 0.5.1 → 0.5.2

data/bunny.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |s|
   s.name = %q{bunny}
-  s.version = "0.5.1"
+  s.version = "0.5.2"
   s.authors = ["Chris Duncan"]
-  s.date = %q{2009-08-08}
+  s.date = %q{2009-08-17}
   s.description = %q{Another synchronous Ruby AMQP client}
   s.email = %q{celldee@gmail.com}
   s.rubyforge_project = %q{bunny-amqp}

data/examples/simple_08.rb

@@ -1,4 +1,4 @@
-# simple.rb
+# simple_08.rb
 
 # Assumes that target message broker/server has a user called 'guest' with a password 'guest'
 # and that it is running on 'localhost'.

data/examples/simple_09.rb

@@ -1,4 +1,4 @@
-# simple.rb
+# simple_09.rb
 
 # Assumes that target message broker/server has a user called 'guest' with a password 'guest'
 # and that it is running on 'localhost'.

data/examples/simple_ack_08.rb

@@ -1,4 +1,4 @@
-# simple_ack.rb
+# simple_ack_08.rb
 
 # Assumes that target message broker/server has a user called 'guest' with a password 'guest'
 # and that it is running on 'localhost'.

data/examples/simple_ack_09.rb

@@ -1,4 +1,4 @@
-# simple_ack.rb
+# simple_ack_09.rb
 
 # Assumes that target message broker/server has a user called 'guest' with a password 'guest'
 # and that it is running on 'localhost'.

data/examples/simple_consumer_08.rb

@@ -1,4 +1,4 @@
-# consumer.rb
+# simple_consumer_08.rb
 
 # N.B. To be used in conjunction with simple_publisher.rb
 
@@ -13,15 +13,18 @@
 #
 # Open up two console windows start this program in one of them by typing -
 #
-# ruby simple_consumer.rb
+# ruby simple_consumer_08.rb
 #
 # Then switch to the other console window and type -
 #
-# ruby simple_publisher.rb
+# ruby simple_publisher_08.rb
 #
 # A message will be printed out by the simple_consumer and it will wait for the next message
+# until the timeout interval is reached.
 #
-# Run simple_publisher 3 more times. After the last run simple_consumer will stop.
+# Run simple_publisher as many times as you like. When you want the program to stop just stop
+# sending messages and the subscribe loop will timeout after 30 seconds, the program will
+# unsubscribe from the queue and close the connection to the server.
 
 $:.unshift File.dirname(__FILE__) + '/../lib'
 
@@ -45,11 +48,14 @@ q.bind(exch, :key => 'fred')
 i = 1
 
 # subscribe to queue
-q.subscribe(:consumer_tag => 'testtag1') do |msg|
-	puts i.to_s + ': ' + msg
+ret = q.subscribe(:consumer_tag => 'testtag1', :timeout => 30) do |msg|
+	puts "#{i.to_s}: #{msg}"
 	i+=1
-	q.unsubscribe(:consumer_tag => 'testtag1') if i == 5
 end
 
-# close the connection
-b.stop
+if ret == :timed_out
+	puts '==== simple_consumer_08.rb timed out - closing down ===='
+	q.unsubscribe(:consumer_tag => 'testtag1')
+	# close the connection
+	b.stop
+end

data/examples/simple_consumer_09.rb

@@ -1,4 +1,4 @@
-# consumer.rb
+# simple_consumer_09.rb
 
 # N.B. To be used in conjunction with simple_publisher.rb
 
@@ -13,15 +13,18 @@
 #
 # Open up two console windows start this program in one of them by typing -
 #
-# ruby simple_consumer.rb
+# ruby simple_consumer_09.rb
 #
 # Then switch to the other console window and type -
 #
-# ruby simple_publisher.rb
+# ruby simple_publisher_09.rb
 #
 # A message will be printed out by the simple_consumer and it will wait for the next message
+# until the timeout interval is reached.
 #
-# Run simple_publisher 3 more times. After the last run simple_consumer will stop.
+# Run simple_publisher as many times as you like. When you want the program to stop just stop
+# sending messages and the subscribe loop will timeout after 30 seconds, the program will
+# unsubscribe from the queue and close the connection to the server.
 
 $:.unshift File.dirname(__FILE__) + '/../lib'
 
@@ -45,11 +48,14 @@ q.bind(exch, :key => 'fred')
 i = 1
 
 # subscribe to queue
-q.subscribe(:consumer_tag => 'testtag1') do |msg|
-	puts i.to_s + ': ' + msg
+ret = q.subscribe(:consumer_tag => 'testtag1', :timeout => 30) do |msg|
+	puts "#{i.to_s}: #{msg}"
 	i+=1
-	q.unsubscribe(:consumer_tag => 'testtag1') if i == 5
 end
 
-# close the connection
-b.stop
+if ret == :timed_out
+	puts '==== simple_consumer_09.rb timed out - closing down ===='
+	q.unsubscribe(:consumer_tag => 'testtag1')
+	# close the connection
+	b.stop
+end

data/examples/simple_fanout_08.rb

@@ -1,4 +1,4 @@
-# fanout.rb
+# simple_fanout_08.rb
 
 # Assumes that target message broker/server has a user called 'guest' with a password 'guest'
 # and that it is running on 'localhost'.

data/examples/simple_fanout_09.rb

@@ -1,4 +1,4 @@
-# fanout.rb
+# simple_fanout_09.rb
 
 # Assumes that target message broker/server has a user called 'guest' with a password 'guest'
 # and that it is running on 'localhost'.

data/examples/simple_headers_08.rb

@@ -1,4 +1,4 @@
-# simple_headers.rb
+# simple_headers_08.rb
 
 # Assumes that target message broker/server has a user called 'guest' with a password 'guest'
 # and that it is running on 'localhost'.

data/examples/simple_headers_09.rb

@@ -1,4 +1,4 @@
-# simple_headers.rb
+# simple_headers_09.rb
 
 # Assumes that target message broker/server has a user called 'guest' with a password 'guest'
 # and that it is running on 'localhost'.

data/examples/simple_publisher_08.rb

@@ -1,6 +1,6 @@
-# simple_publisher.rb
+# simple_publisher_08.rb
 
-# N.B. To be used in conjunction with simple_consumer.rb. See simple_consumer.rb for explanation.
+# N.B. To be used in conjunction with simple_consumer_08.rb. See simple_consumer.rb for explanation.
 
 # Assumes that target message broker/server has a user called 'guest' with a password 'guest'
 # and that it is running on 'localhost'.

data/examples/simple_topic_08.rb

@@ -1,4 +1,4 @@
-# simple_topic.rb
+# simple_topic_08.rb
 
 # Assumes that target message broker/server has a user called 'guest' with a password 'guest'
 # and that it is running on 'localhost'.

data/examples/simple_topic_09.rb

@@ -1,4 +1,4 @@
-# simple_topic.rb
+# simple_topic_09.rb
 
 # Assumes that target message broker/server has a user called 'guest' with a password 'guest'
 # and that it is running on 'localhost'.

data/lib/bunny.rb

@@ -12,7 +12,7 @@ module Bunny
 	class ConnectionError < StandardError; end
 	class MessageError < StandardError; end
 	
-	VERSION = '0.5.1'
+	VERSION = '0.5.2'
 	
 	# Returns the Bunny version number
 

data/lib/bunny/client08.rb

@@ -34,6 +34,9 @@ Sets up a Bunny::Client object ready for connection to a broker/server. _Client_
   servers, the server may respond to a Connection::Open method with a Connection::Redirect. The insist
   option, if set to _true_, tells the server that the client is insisting on a connection to the
   specified server.
+* <tt>:frame_max => maximum frame size in bytes (default = 131072)</tt>
+* <tt>:channel_max => maximum number of channels (default = 0 no maximum)</tt>
+* <tt>:heartbeat => number of seconds (default = 0 no heartbeat)</tt>
 
 =end
 
@@ -50,10 +53,16 @@ Sets up a Bunny::Client object ready for connection to a broker/server. _Client_
       @status = :not_connected
 			@frame_max = opts[:frame_max] || 131072
 			@channel_max = opts[:channel_max] || 0
+			@heartbeat = opts[:heartbeat] || 0
 			@logger = nil
 			create_logger if @logging
+			@channels = []
 			# Create channel 0
       @channel = Bunny::Channel.new(self, true)
+			@exchanges = {}
+			@queues = {}
+			@heartbeat_in = false
+			@connecting = false
     end
 
 =begin rdoc
@@ -91,18 +100,6 @@ Exchange
 
 === DESCRIPTION:
 
-Returns hash of exchanges declared by Bunny.
-
-=end
-
-		def exchanges
-			@exchanges ||= {}
-		end
-
-=begin rdoc
-
-=== DESCRIPTION:
-
 Declares a queue to the broker/server. If the queue does not exist, a new one is created
 using the arguments passed in. If the queue already exists, a reference to it is created, provided
 that the arguments passed in do not conflict with the existing attributes of the queue. If an error
@@ -141,19 +138,16 @@ Queue
 
       return queues[name] if queues.has_key?(name)
 
-      queue = Bunny::Queue.new(self, name, opts)
+      Bunny::Queue.new(self, name, opts)
 	  end
-	
-=begin rdoc
-
-=== DESCRIPTION:
-
-Returns hash of queues declared by Bunny.
-
-=end
 		
-		def queues
-			@queues ||= {}
+		def send_heartbeat
+			# Create a new heartbeat frame
+			hb = Qrack::Transport::Heartbeat.new('')		
+			# Channel 0 must be used
+			switch_channel(0) if @channel.number > 0			
+			# Send the heartbeat to server
+			send_frame(hb)
 		end
 
     def send_frame(*args)
@@ -169,18 +163,72 @@ Returns hash of queues declared by Bunny.
       nil
     end
 
-    def next_frame
-      frame = Qrack::Transport::Frame.parse(buffer)
-			@logger.info("received") { frame } if @logging
-      frame
+    def next_frame(opts = {})
+			secs = opts[:timeout] || 0
+			
+			begin
+				Timeout::timeout(secs) do
+					@frame = Qrack::Transport::Frame.parse(buffer)
+				end
+			rescue Timeout::Error
+				return :timed_out
+			end
+			
+			@logger.info("received") { @frame } if @logging
+						
+			raise Bunny::ConnectionError, 'No connection to server' if (@frame.nil? and !connecting?)
+
+			if @frame.is_a?(Qrack::Transport::Heartbeat)
+				@heartbeat_in = true
+				next_frame
+			end
+			
+			@frame
     end
 
     def next_payload
-      frame = next_frame
+      frame = next_frame			
 			frame.payload
     end
 
 		alias next_method next_payload
+		
+=begin rdoc
+
+=== DESCRIPTION:
+
+Checks to see whether or not an undeliverable message has been returned as a result of a publish
+with the <tt>:immediate</tt> or <tt>:mandatory</tt> options.
+
+==== OPTIONS:
+
+* <tt>:timeout => number of seconds (default = 0.1) - The method will wait for a return
+  message until this timeout interval is reached.
+
+==== RETURNS:
+
+<tt>:no_return</tt> if message was not returned before timeout .
+<tt>{:header, :return_details, :payload}</tt> if message is returned. <tt>:return_details</tt> is
+a hash <tt>{:reply_code, :reply_text, :exchange, :routing_key}</tt>.
+
+=end
+		
+		def returned_message(opts = {})
+			secs = opts[:timeout] || 0.1		
+			frame = next_frame(:timeout => secs)
+			
+			if frame.is_a?(Symbol)
+				return :no_return if frame == :timed_out
+			end
+
+			method = frame.payload
+			header = next_payload
+	    msg = next_payload
+	    raise Bunny::MessageError, 'unexpected length' if msg.length < header.size
+			
+			# Return the message and related info
+			{:header => header, :payload => msg, :return_details => method.arguments}
+		end
 
 =begin rdoc
 
@@ -197,12 +245,9 @@ _Bunny_::_ProtocolError_ is raised. If successful, _Client_._status_ is set to <
 
     def close
 			# Close all active channels
-			channels.each_value do |c|
+			channels.each do |c|
 				c.close if c.open?
 			end
-			
-			# Set client channel to zero
-      self.channel = channels[0]
 
 			# Close connection to AMQP server
 			close_connection
@@ -235,6 +280,8 @@ _Bunny_::_ProtocolError_ is raised. If successful, _Client_._status_ is set to <
 =end
 		
 		def start_session
+			@connecting = true
+			
       loop do
 				# Create/get socket
 				socket
@@ -246,15 +293,17 @@ _Bunny_::_ProtocolError_ is raised. If successful, _Client_._status_ is set to <
 				break if open_connection == :ok
       end
 
-			# Open a channel
-			self.channel = get_channel
-			channel.open
+			# Open another channel because channel zero is used for specific purposes
+			c = create_channel()
+			c.open
 			
 			# Get access ticket
 			request_access
 
+			@connecting = false
+			
 			# return status
-			status
+			@status = :connected
     end
 
 		alias start start_session
@@ -263,7 +312,7 @@ _Bunny_::_ProtocolError_ is raised. If successful, _Client_._status_ is set to <
 
 === DESCRIPTION:
 
-Asks the broker to redeliver all unacknowledged messages on a specifieid channel. Zero or
+Asks the broker to redeliver all unacknowledged messages on a specified channel. Zero or
 more messages may be redelivered.
 
 ==== Options:
@@ -388,23 +437,36 @@ after a rollback.
 			@logging = bool
 			create_logger if @logging
 		end
-			
-		def channels
-			@channels ||= {}
-		end
 		
-		def get_channel
-			channels.each_value do |c|
+		def create_channel
+			channels.each do |c|
 				return c if (!c.open? and c.number != 0)
 			end
 			# If no channel to re-use instantiate new one
 			Bunny::Channel.new(self)
 		end
 		
+		def switch_channel(chann)
+			if (0...channels.size).include? chann
+				@channel = channels[chann]
+				chann
+			else
+				raise RuntimeError, "Invalid channel number - #{chann}"
+			end
+		end
+		
+		def connecting?
+			connecting
+		end
+		
 		def init_connection
 			write(Qrack::Protocol::HEADER)
       write([1, 1, Qrack::Protocol::VERSION_MAJOR, Qrack::Protocol::VERSION_MINOR].pack('C4'))
-      raise Bunny::ProtocolError, 'Connection initiation failed' unless next_method.is_a?(Qrack::Protocol::Connection::Start)
+
+			frame = next_frame
+			if frame.nil? or !frame.payload.is_a?(Qrack::Protocol::Connection::Start)
+				raise Bunny::ProtocolError, 'Connection initiation failed'
+			end
 		end
 		
 		def open_connection
@@ -417,12 +479,14 @@ after a rollback.
         )
       )
 
-      method = next_method
-      raise Bunny::ProtocolError, "Connection failed - user: #{@user}, pass: #{@pass}" if method.nil?
+      frame = next_frame
+			raise Bunny::ProtocolError, "Connection failed - user: #{@user}, pass: #{@pass}" if frame.nil?
+			
+			method = frame.payload
 
       if method.is_a?(Qrack::Protocol::Connection::Tune)
         send_frame(
-          Qrack::Protocol::Connection::TuneOk.new( :channel_max => @channel_max, :frame_max => @frame_max, :heartbeat => 0)
+          Qrack::Protocol::Connection::TuneOk.new( :channel_max => @channel_max, :frame_max => @frame_max, :heartbeat => @heartbeat)
         )
       end
 
@@ -444,6 +508,9 @@ after a rollback.
 		end
 
 		def close_connection
+			# Set client channel to zero
+      switch_channel(0)
+		
 			send_frame(
 	      Qrack::Protocol::Connection::Close.new(:reply_code => 200, :reply_text => 'Goodbye', :class_id => 0, :method_id => 0)
 	    )
@@ -477,9 +544,7 @@ after a rollback.
     def socket
       return @socket if @socket and (@status == :connected) and not @socket.closed?
 
-      begin
-        @status = :not_connected
-   
+      begin  
         # Attempt to connect.
         @socket = timeout(CONNECT_TIMEOUT) do
           TCPSocket.new(host, port)
@@ -488,7 +553,6 @@ after a rollback.
         if Socket.constants.include? 'TCP_NODELAY'
           @socket.setsockopt Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1
         end
-        @status   = :connected
       rescue => e
         @status = :not_connected
         raise Bunny::ServerDownError, e.message