amqp 0.8.0.rc2 → 0.8.0.rc3

data/docs/Queues.textile

@@ -0,0 +1,27 @@
+h1. TBD
+
+
+h2. About this guide
+
+TBD
+
+
+h2. Covered versions
+
+This guide covers amqp gem v0.8.0 and later.
+
+
+
+h2. TBD
+
+TBD
+
+
+
+h2. Tell us what you think!
+
+Please take a moment and tell us what you think about this guide on "Ruby AMQP mailing list":http://groups.google.com/group/ruby-amqp:
+what was unclear? what wasn't covered? maybe you don't like guide style or grammar and spelling are incorrect? Readers feedback is
+key to making documentation better.
+
+If mailing list communication is not an option for you for some reason, you can "contact guides author directly":mailto:michael@novemberain.com?subject=amqp%20gem%20documentation

data/docs/RabbitMQVersions.textile

@@ -4,7 +4,7 @@ h2. Using recent versions on Debian and Ubuntu
 
 Ubuntu (even 10.10) and Debian both "ship with old RabbitMQ version":http://packages.ubuntu.com/maverick/rabbitmq-server,
 that only supports AMQP protocol 0.8. amqp gem 0.8.0 and later *will not work with RabbitMQ versions
-before 1.8.0*.
+before 2.0.0*.
 
 We strongly recommend that you use "RabbitMQ apt repository":http://www.rabbitmq.com/debian.html#apt that has recent versions of RabbitMQ.
 
@@ -18,4 +18,14 @@ support, RabbitMQ 1.7.0 requires
  * Erlang/OTP R13B or later
  * Erlang SSL 3.10 or later
 
-and recommends using Erlang R141B that ships with Erlang SSL 4.0.1.
+and recommends using Erlang R141B that ships with Erlang SSL 4.0.1.
+
+
+
+h2. Tell us what you think!
+
+Please take a moment and tell us what you think about this guide on "Ruby AMQP mailing list":http://groups.google.com/group/ruby-amqp:
+what was unclear? what wasn't covered? maybe you don't like guide style or grammar and spelling are incorrect? Readers feedback is
+key to making documentation better.
+
+If mailing list communication is not an option for you for some reason, you can "contact guides author directly":mailto:michael@novemberain.com?subject=amqp%20gem%20documentation

data/docs/Routing.textile

@@ -0,0 +1,27 @@
+h1. TBD
+
+
+h2. About this guide
+
+TBD
+
+
+h2. Covered versions
+
+This guide covers amqp gem v0.8.0 and later.
+
+
+
+h2. TBD
+
+TBD
+
+
+
+h2. Tell us what you think!
+
+Please take a moment and tell us what you think about this guide on "Ruby AMQP mailing list":http://groups.google.com/group/ruby-amqp:
+what was unclear? what wasn't covered? maybe you don't like guide style or grammar and spelling are incorrect? Readers feedback is
+key to making documentation better.
+
+If mailing list communication is not an option for you for some reason, you can "contact guides author directly":mailto:michael@novemberain.com?subject=amqp%20gem%20documentation

data/docs/TLS.textile

@@ -0,0 +1,27 @@
+h1. TBD
+
+
+h2. About this guide
+
+TBD
+
+
+h2. Covered versions
+
+This guide covers amqp gem v0.8.0 and later.
+
+
+
+h2. TBD
+
+TBD
+
+
+
+h2. Tell us what you think!
+
+Please take a moment and tell us what you think about this guide on "Ruby AMQP mailing list":http://groups.google.com/group/ruby-amqp:
+what was unclear? what wasn't covered? maybe you don't like guide style or grammar and spelling are incorrect? Readers feedback is
+key to making documentation better.
+
+If mailing list communication is not an option for you for some reason, you can "contact guides author directly":mailto:michael@novemberain.com?subject=amqp%20gem%20documentation

data/docs/VendorSpecificExtensions.textile

@@ -29,4 +29,14 @@ h3. Example of using publisher confirmations
 
 h3. Documentation
 
-RabbitMQ extensions documentation is part of "amq-client gem documentation":http://rubydoc.info/github/ruby-amqp/amq-client/master/frames
+RabbitMQ extensions documentation is part of "amq-client gem documentation":http://rubydoc.info/github/ruby-amqp/amq-client/master/frames
+
+
+
+h2. Tell us what you think!
+
+Please take a moment and tell us what you think about this guide on "Ruby AMQP mailing list":http://groups.google.com/group/ruby-amqp:
+what was unclear? what wasn't covered? maybe you don't like guide style or grammar and spelling are incorrect? Readers feedback is
+key to making documentation better.
+
+If mailing list communication is not an option for you for some reason, you can "contact guides author directly":mailto:michael@novemberain.com?subject=amqp%20gem%20documentation

data/examples/{various → channels}/open_channel_without_assignment.rb

@@ -20,10 +20,6 @@ AMQP.start(:host => 'localhost') do |connection|
   show_stopper = Proc.new do
     $stdout.puts "Stopping..."
 
-    # queue.purge :nowait => true
-
-    # now change this to just EM.stop and it
-    # unbinds instantly
     connection.close {
       EM.stop { exit }
     }

data/examples/channels/prefetch_as_constructor_argument.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 "=> Channel#prefetch"
+puts
+AMQP.start(:host => 'localhost') do |connection|
+  ch = AMQP::Channel.new(connection, AMQP::Channel.next_channel_id, :prefetch => 1)
+  ch.on_error do |ex|
+    raise "Oops! there has been a channel-level exception"
+  end
+
+
+  show_stopper = Proc.new do
+    $stdout.puts "Stopping..."
+
+    connection.close {
+      EM.stop { exit }
+    }
+  end
+
+  Signal.trap "INT", show_stopper
+  EM.add_timer(1, show_stopper)
+end

data/examples/channels/qos_aka_prefetch.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require "bundler"
+Bundler.setup
+
+$:.unshift(File.expand_path("../../../lib", __FILE__))
+
+require 'amqp'
+
+
+puts "=> Channel#prefetch"
+puts
+AMQP.start(:host => 'localhost') do |connection|
+  ch = AMQP::Channel.new
+  ch.on_error do |ex|
+    raise "Oops! there has been a channel-level exception"
+  end
+  ch.prefetch(1, false) do |_|
+    puts "qos callback has fired"
+  end
+
+
+  show_stopper = Proc.new do
+    $stdout.puts "Stopping..."
+
+    connection.close {
+      EM.stop { exit }
+    }
+  end
+
+  Signal.trap "INT", show_stopper
+  EM.add_timer(1, show_stopper)
+end

data/examples/channels/qos_aka_prefetch_without_callback.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require "bundler"
+Bundler.setup
+
+$:.unshift(File.expand_path("../../../lib", __FILE__))
+
+require 'amqp'
+
+
+puts "=> Channel#prefetch"
+puts
+AMQP.start(:host => 'localhost') do |connection|
+  ch = AMQP::Channel.new
+  ch.on_error do |ex|
+    raise "Oops! there has been a channel-level exception"
+  end
+  ch.prefetch(1, false)
+
+
+  show_stopper = Proc.new do
+    $stdout.puts "Stopping..."
+
+    connection.close {
+      EM.stop { exit }
+    }
+  end
+
+  Signal.trap "INT", show_stopper
+  EM.add_timer(1, show_stopper)
+end

data/examples/error_handling/channel_level_exception.rb

@@ -0,0 +1,47 @@
+#!/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("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 channel-level exception"
+    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/channel_level_exception_with_multiple_channels_involved.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("amqp://guest:guest@dev.rabbitmq.com:5672/") do |connection, open_ok|
+  ch1 = AMQP::Channel.new(connection) do |ch, open_ok|
+    puts "Channel ##{ch.id} is now open!"
+  end
+  ch1.on_error do |ch, close|
+    raise "Handling channel-level exception on channel with id of #{ch.id} (ch1)"
+  end
+
+  ch2 = AMQP::Channel.new(connection) do |ch, open_ok|
+    puts "Channel ##{ch.id} is now open!"
+  end
+  ch2.on_error do |ch, close|
+    puts "Handling channel-level exception on channel with id of #{ch.id} (ch2)"
+  end
+
+
+  EventMachine.add_timer(0.2) do
+    AMQP::Queue.new(ch1, "amqpgem.examples.channel_exception", :auto_delete => true, :durable => false) do |queue|
+      puts "#{queue.name} is ready to go"
+    end
+  end
+
+  EventMachine.add_timer(0.6) do
+    AMQP::Queue.new(ch2, "amqpgem.examples.channel_exception", :auto_delete => true, :durable => true) do |queue|
+      puts "#{queue.name} is ready to go"
+    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/connection_loss_handler.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require "bundler"
+Bundler.setup
+
+$:.unshift(File.expand_path("../../../lib", __FILE__))
+
+require 'amqp'
+
+
+puts "=> Connection loss is detected and handled"
+puts
+AMQP.start(:port     => 5672,
+           :vhost    => "/amq_client_testbed",
+           :user     => "amq_client_gem",
+           :password => "amq_client_gem_password",
+           :timeout        => 0.3,
+           :on_tcp_connection_failure => Proc.new { |settings| puts "Failed to connect, this was NOT expected"; EM.stop }) do |connection, open_ok|
+    connection.on_tcp_connection_loss do |cl, settings|
+      puts "tcp_connection_loss handler kicks in"
+      cl.reconnect(false, 1)
+    end
+
+
+  show_stopper = Proc.new do
+    $stdout.puts "Stopping..."
+
+    connection.close {
+      EM.stop { exit }
+    }
+  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/global_channel_level_exception_handler.rb

@@ -0,0 +1,65 @@
+#!/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 by a global callback we carry from 0.7.x days"
+puts
+
+puts <<-MSG
+WARNING!! ACHTUNG!! AVIS!! AVISO!! Poorly designed API use ahead!!
+
+Please never ever use global error handler demonstrated below!
+It is a brilliant decision from early days of the library and we have to carry it
+along for backwards compatibility.
+
+Global state is programming is usually a pain. Global error handling is a
+true Hell.
+
+You have been warned.
+MSG
+
+puts
+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 channel-level exception at instance level"
+    end
+
+    AMQP::Channel.on_error do |ch, close|
+      puts "Handling channel-level exception at GLOBAL level. Jeez."
+    end
+
+    EventMachine.add_timer(0.4) do
+      q1 = AMQP::Queue.new(channel, "amqpgem.examples.channel_exception", :auto_delete => true, :durable => false) do |queue|
+        puts "#{queue.name} is ready to go"
+      end
+
+      q2 = 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