amqp 0.8.0.rc13 → 0.8.0.rc14

data/examples/error_handling/connection_level_exception_with_objects.rb

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require "bundler"
+Bundler.setup
+
+$:.unshift(File.expand_path("../../../lib", __FILE__))
+
+require 'amqp'
+
+
+class ConnectionManager
+
+  #
+  # API
+  #
+
+  def connect(*args, &block)
+    @connection = AMQP.connect(*args, &block)
+
+    # combines Object#method and Method#to_proc to use object
+    # method as a callback
+    @connection.on_error(&method(:on_error))
+  end # connect(*args, &block)
+
+
+  def on_error(connection, connection_close)
+    puts "Handling a connection-level exception."
+    puts
+    puts "AMQP class id : #{connection_close.class_id}"
+    puts "AMQP method id: #{connection_close.method_id}"
+    puts "Status code   : #{connection_close.reply_code}"
+    puts "Error message : #{connection_close.reply_text}"
+  end # on_error(connection, connection_close)
+end
+
+EventMachine.run do
+  manager = ConnectionManager.new
+  manager.connect(:host => '127.0.0.1', :port => 5672) do |connection|
+    puts "Connected to AMQP broker. Running #{AMQP::VERSION} version of the gem..."
+
+    # send_frame is NOT part of the public API, but it is public for entities like AMQ::Client::Channel
+    # and we use it here to trigger a connection-level exception. MK.
+    connection.send_frame(AMQ::Protocol::Connection::TuneOk.encode(1000, 1024 * 128 * 1024, 10))
+  end
+
+  # shut down after 2 seconds
+  EventMachine.add_timer(2) { EventMachine.stop }
+end

data/examples/error_handling/connection_loss_handler.rb

@@ -25,15 +25,11 @@ AMQP.start(:port     => 5672,
 
   show_stopper = Proc.new do
     $stdout.puts "Stopping..."
-
-    connection.close {
-      EM.stop { exit }
-    }
+    connection.close { EventMachine.stop }
   end
 
   puts "Connected, authenticated. To really exercise this example, shut AMQP broker down for a few seconds. If you don't it will exit gracefully in 30 seconds."
 
-  Signal.trap "TERM", show_stopper
   Signal.trap "INT",  show_stopper
   EM.add_timer(30, show_stopper)
 end

data/examples/error_handling/hello_world_producer.rb

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require "bundler"
+Bundler.setup
+
+$:.unshift(File.expand_path("../../../lib", __FILE__))
+
+require 'amqp'
+
+
+puts "=> Auxiliary script that tests automatically recovering message consumer(s)"
+puts
+AMQP.start(:host => "localhost") do |connection, open_ok|
+  connection.on_error do |ch, connection_close|
+    raise connection_close.reply_text
+  end
+
+  ch1 = AMQP::Channel.new(connection, 2)
+  ch1.on_error do |ch, channel_close|
+    raise channel_close.reply_text
+  end
+
+
+  exchange = ch1.fanout("amq.fanout", :durable => true)
+  EventMachine.add_periodic_timer(0.5) do
+    puts "Publishing..."
+    # messages must be routable & there must be at least one consumer.
+    exchange.publish("Hello", :immediate => true, :mandatory => true)
+  end
+
+
+  show_stopper = Proc.new {
+    connection.disconnect { puts "Disconnected. Exiting…"; EventMachine.stop }
+  }
+
+  Signal.trap "TERM", show_stopper
+  Signal.trap "INT",  show_stopper
+  EM.add_timer(15, show_stopper)
+
+  puts "This example a helper that publishes messages to amq.fanout. Use together with examples/error_handling/automatically_recovering_hello_world_consumer.rb."
+  puts "This example terminates in 15 seconds and needs MANUAL RESTART when connection fails"
+end

data/examples/error_handling/insufficient_permissions.rb

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require "bundler"
+Bundler.setup
+
+$:.unshift(File.expand_path("../../../lib", __FILE__))
+
+require 'amqp'
+
+
+puts "=> Queue redeclaration with different attributes results in a channel exception that is handled"
+puts
+AMQP.start(:vhost => "amqp_gem_testbed", :username => "amqp_gem_reader", :password => "reader_password") do |connection, open_ok|
+  AMQP::Channel.new do |channel, open_ok|
+    puts "Channel ##{channel.id} is now open!"
+
+    channel.on_error do |ch, channel_close|
+      puts <<-ERR
+      Handling a channel-level exception.
+
+      AMQP class id : #{channel_close.class_id},
+      AMQP method id: #{channel_close.method_id},
+      Status code   : #{channel_close.reply_code}
+      Error message : #{channel_close.reply_text}
+      ERR
+    end
+
+    EventMachine.add_timer(0.4) do
+      # these two definitions result in a race condition. For sake of this example,
+      # however, it does not matter. Whatever definition succeeds first, 2nd one will
+      # cause a channel-level exception (because attributes are not identical)
+      AMQP::Queue.new(channel, "amqpgem.examples.channel_exception", :auto_delete => true, :durable => false) do |queue|
+        puts "#{queue.name} is ready to go"
+      end
+
+      AMQP::Queue.new(channel, "amqpgem.examples.channel_exception", :auto_delete => true, :durable => true) do |queue|
+        puts "#{queue.name} is ready to go"
+      end
+    end
+  end
+
+
+  show_stopper = Proc.new do
+    $stdout.puts "Stopping..."
+
+    connection.close {
+      EM.stop { exit }
+    }
+  end
+
+  Signal.trap "INT", show_stopper
+  EM.add_timer(2, show_stopper)
+end

data/examples/error_handling/manual_connection_and_channel_recovery.rb

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require "bundler"
+Bundler.setup
+
+$:.unshift(File.expand_path("../../../lib", __FILE__))
+
+require 'amqp'
+
+
+class ConnectionInterruptionHandler
+
+  #
+  # API
+  #
+
+  def handle(connection)
+    puts "[network failure] Connection #{connection} detected connection interruption"
+  end
+
+end
+
+
+puts "=> Example of AMQP connection & channel recovery API in action"
+puts
+AMQP.start(:host => "localhost") do |connection, open_ok|
+  unless connection.auto_recovering?
+    puts "Connection IS NOT auto-recovering..."
+  end
+
+  ch1 = AMQP::Channel.new(connection)
+  ch1.on_error do |ch, channel_close|
+    raise channel_close.reply_text
+  end
+
+  unless ch1.auto_recovering?
+    puts "Channel #{ch1.id} IS NOT auto-recovering"
+  end
+  ch1.on_connection_interruption do |c|
+    puts "[network failure] Channel #{c.id} reacted to connection interruption"
+  end
+  ch1.on_recovery do |c|
+    puts "[recovery] Channel #{c.id} has recovered"
+  end
+
+
+  connection.on_tcp_connection_loss do |conn, settings|
+    puts "[network failure] Trying to reconnect..."
+    conn.reconnect(false, 2)
+  end
+
+
+  handler = ConnectionInterruptionHandler.new
+  connection.on_connection_interruption(&handler.method(:handle))
+
+  connection.on_recovery do |conn, settings|
+    puts "[recovery] Connection has recovered"
+  end
+
+  show_stopper = Proc.new {
+    connection.disconnect { puts "Disconnected. Exiting…"; EventMachine.stop }
+  }
+
+  Signal.trap "TERM", show_stopper
+  Signal.trap "INT",  show_stopper
+  EM.add_timer(30, show_stopper)
+
+
+  puts "Connected, authenticated. To really exercise this example, shut AMQP broker down for a few seconds. If you don't it will exit gracefully in 30 seconds."
+end

data/examples/error_handling/queue_exclusivity_violation.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require "bundler"
+Bundler.setup
+
+$:.unshift(File.expand_path("../../../lib", __FILE__))
+
+require 'amqp'
+
+
+puts "=> Queue exclusivity violation results "
+puts
+EventMachine.run do
+  connection1 = AMQP.connect("amqp://guest:guest@dev.rabbitmq.com")
+  channel1    = AMQP::Channel.new(connection1)
+
+  connection2 = AMQP.connect("amqp://guest:guest@dev.rabbitmq.com")
+  channel2    = AMQP::Channel.new(connection2)
+
+  channel1.on_error do |ch, close|
+    puts "Handling a channel-level exception on channel1: #{close.reply_text}, #{close.reply_code}"
+  end
+  channel2.on_error do |ch, close|
+    puts "Handling a channel-level exception on channel2: #{close.reply_text}, #{close.reply_code}"
+  end
+
+  name = "amqpgem.examples.queue"
+  channel1.queue(name, :auto_delete => true, :exclusive => true)
+  # declare a queue with the same name on a different connection
+  channel2.queue(name, :auto_delete => true, :exclusive => true)
+
+
+  EventMachine.add_timer(3.5) do
+    connection1.close {
+      connection2.close {
+        EventMachine.stop { exit }
+      }
+    }
+  end
+end

data/examples/error_handling/queue_name_violation.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require "bundler"
+Bundler.setup
+
+$:.unshift(File.expand_path("../../../lib", __FILE__))
+
+require 'amqp'
+
+
+puts "=> Queue declaration uses name prefix amq.* reserved by the AMQP spec"
+puts
+AMQP.start("amqp://guest:guest@dev.rabbitmq.com:5672") do |connection, open_ok|
+  AMQP::Channel.new do |channel, open_ok|
+    puts "Channel ##{channel.id} is now open!"
+
+    channel.on_error do |ch, close|
+      puts "Handling a channel-level exception: #{close.reply_text}, code: #{close.reply_code}"
+    end
+
+    channel.queue("amq.queue")
+  end
+
+
+  EventMachine.add_timer(0.5) do
+    connection.close {
+      EventMachine.stop { exit }
+    }
+  end
+end

data/examples/exchanges/autodeletion_of_exchanges.rb

@@ -26,10 +26,7 @@ AMQP.start(:host => 'localhost', :port => 5673) do |connection|
 
   show_stopper = Proc.new do
     $stdout.puts "Stopping..."
-
-    connection.close {
-      EM.stop { exit }
-    }
+    connection.close { EventMachine.stop }
   end
 
   Signal.trap "INT", show_stopper

data/examples/guides/queues/01a_declaring_a_server_named_queue_using_queue_constructor.rb

@@ -4,15 +4,14 @@
 require "rubygems"
 require "amqp"
 
-# Declaring a server-named queue using AMQP::Queue constructor
+# Declaring a queue with server-generated name using AMQP::Queue constructor
 AMQP.start("amqp://guest:guest@dev.rabbitmq.com") do |connection, open_ok|
-  AMQP::Channel.new do |channel, open_ok|
-    AMQP::Queue.new(channel, "", :auto_delete => true) do |queue, declare_ok|
-      puts "#{queue.name} is ready to go. AMQP method: #{declare_ok.inspect}"
+  channel = AMQP::Channel.new(connection)
+  AMQP::Queue.new(channel, "", :auto_delete => true) do |queue|
+    puts "#{queue.name} is ready to go."
 
-      connection.close {
-        EventMachine.stop { exit }
-      }
-    end
+    connection.close {
+      EventMachine.stop { exit }
+    }
   end
 end

data/examples/guides/queues/01b_declaring_a_queue_using_queue_constructor.rb

@@ -6,13 +6,12 @@ require "amqp"
 
 # Declaring a queue with explicitly given name using AMQP::Queue constructor
 AMQP.start("amqp://guest:guest@dev.rabbitmq.com") do |connection, open_ok|
-  AMQP::Channel.new do |channel, open_ok|
-    AMQP::Queue.new(channel, "images.resize", :auto_delete => true) do |queue, declare_ok|
-      puts "#{queue.name} is ready to go."
+  channel = AMQP::Channel.new(connection)
+  queue   = AMQP::Queue.new(channel, "images.resize", :auto_delete => true)
 
-      connection.close {
-        EventMachine.stop { exit }
-      }
-    end
-  end
+  puts "#{queue.name} is ready to go."
+
+  connection.close {
+    EventMachine.stop { exit }
+  }
 end

data/examples/guides/queues/02a_declaring_a_durable_shared_queue.rb

@@ -6,13 +6,10 @@ require "amqp"
 
 # Declaring a durable shared queue
 AMQP.start("amqp://guest:guest@dev.rabbitmq.com") do |connection, open_ok|
-  AMQP::Channel.new do |channel, open_ok|
-    AMQP::Queue.new(channel, "images.resize", :durable => true) do |queue, declare_ok|
-      puts "#{queue.name} is ready to go."
+  channel = AMQP::Channel.new(connection)
+  queue   = AMQP::Queue.new(channel, "images.resize", :durable => true)
 
-      connection.close {
-        EventMachine.stop { exit }
-      }
-    end
-  end
+  connection.close {
+    EventMachine.stop { exit }
+  }
 end

data/examples/guides/queues/02b_declaring_a_durable_shared_queue.rb

@@ -6,13 +6,10 @@ require "amqp"
 
 # Declaring a durable shared queue using AMQP::Channel#queue method
 AMQP.start("amqp://guest:guest@dev.rabbitmq.com") do |connection, open_ok|
-  AMQP::Channel.new do |channel, open_ok|
-    channel.queue("images.resize", :durable => true) do |queue, declare_ok|
-      puts "#{queue.name} is ready to go."
+  channel = AMQP::Channel.new(connection)
+  queue   = channel.queue("images.resize", :durable => true)
 
-      connection.close {
-        EventMachine.stop { exit }
-      }
-    end
-  end
+  connection.close {
+    EventMachine.stop { exit }
+  }
 end

data/examples/guides/queues/03a_declaring_a_temporary_exclusive_queue.rb

@@ -6,14 +6,13 @@ require "amqp"
 
 # Declaring a temporary exclusive queue
 AMQP.start("amqp://guest:guest@dev.rabbitmq.com") do |connection, open_ok|
-  AMQP::Channel.new do |channel, open_ok|
-    AMQP::Queue.new(channel, "", :auto_delete => true, :exclusive => true) do |queue, declare_ok|
-      puts "#{queue.name} is ready to go."
+  channel = AMQP::Channel.new(connection)
 
-      connection.close {
-        EventMachine.stop { exit }
-      }
-    end
+  AMQP::Queue.new(channel, "", :auto_delete => true, :exclusive => true) do |queue, declare_ok|
+    puts "#{queue.name} is ready to go."
+
+    connection.close {
+      EventMachine.stop { exit }
+    }
   end
 end
-

data/examples/guides/queues/04_bind_a_queue_using_exchange_instance.rb

@@ -6,17 +6,16 @@ require "amqp"
 
 # Binding a queue to an exchange
 AMQP.start("amqp://guest:guest@dev.rabbitmq.com") do |connection, open_ok|
-  AMQP::Channel.new do |channel, open_ok|
-    exchange = channel.fanout("amq.fanout")
+  channel  = AMQP::Channel.new(connection)
+  exchange = channel.fanout("amq.fanout")
 
-    channel.queue("", :auto_delete => true, :exclusive => true) do |queue, declare_ok|
-      queue.bind(exchange) do |bind_ok|
-        puts "Just bound #{queue.name} to #{exchange.name}"
-      end
-
-      connection.close {
-        EventMachine.stop { exit }
-      }
+  channel.queue("", :auto_delete => true, :exclusive => true) do |queue, declare_ok|
+    queue.bind(exchange) do |bind_ok|
+      puts "Just bound #{queue.name} to #{exchange.name}"
     end
+
+    connection.close {
+      EventMachine.stop { exit }
+    }
   end
 end