README.md in amqp-1.0.0.pre2 vs README.md in amqp-1.0.0
- old
+ new
@@ -1,31 +1,30 @@
-# About Ruby amqp gem #
+# Ruby amqp gem: the asynchronous Ruby RabbitMQ client
[Ruby amqp gem](http://rubyamqp.info) is a widely used, feature-rich, well-maintained asynchronous AMQP 0.9.1 client with batteries included.
This library works with Ruby 1.8.7 (*except for p249*, see the FAQ), Ruby 1.9.2, Ruby 1.9.3, [JRuby](http://jruby.org), [Rubinius](http://rubini.us) as well as [REE](http://www.rubyenterpriseedition.com), and is licensed under the [Ruby License](http://www.ruby-lang.org/en/LICENSE.txt)
-0.8.0 and later versions of amqp gem implement [AMQP 0.9.1](http://bit.ly/amqp-model-explained) (see also [AMQP 0.9.1 spec document](http://bit.ly/amqp091spec)) and support [RabbitMQ extensions to AMQP 0.9.1](http://www.rabbitmq.com/extensions.html).
+0.8.0 and later versions of amqp gem implement [AMQP 0.9.1](http://www.rabbitmq.com/tutorials/amqp-concepts.html) (see also [AMQP 0.9.1 spec document](http://bit.ly/amqp091spec)) and support [RabbitMQ extensions to AMQP 0.9.1](http://www.rabbitmq.com/extensions.html).
-[](http://travis-ci.org/ruby-amqp/amqp)
+## I know what AMQP is, how do I get started?
-## I know what AMQP is, how do I get started? ##
+See [Getting started with amqp gem](http://rubyamqp.info/articles/getting_started/) and other [amqp gem documentation guides](http://rubyamqp.info/).
+We recommend that you read [AMQP 0.9.1 Model Explained](http://www.rabbitmq.com/tutorials/amqp-concepts.html), too.
-See [Getting started with amqp gem](http://bit.ly/getting-started-with-amqp-ruby-gem) and other [documentation guides](http://bit.ly/amqp-gem-docs). We recommend that you read [AMQP 0.9.1 Model Explained](http://bit.ly/amqp-model-explained), too.
+## What is AMQP?
-## What is AMQP? ##
-
AMQP is an [open standard for messaging middleware](http://www.amqp.org/confluence/display/AMQP/About+AMQP) that
emphasizes interoperability between different technologies (for example, Java, .NET, Ruby, Python, Node.js, Erlang, C and so on).
Key features of AMQP are very flexible yet simple routing and binary protocol efficiency. AMQP supports many sophisticated features, for example,
message acknowledgements, returning of messages to producer, redelivery of messages that couldn't be processed, load balancing between message consumers and so on.
-## What is amqp gem good for? ##
+## What is amqp gem good for?
One can use amqp gem to make Ruby applications interoperate with other
applications (both Ruby and not). Complexity and size may vary from
simple work queues to complex multi-stage data processing workflows that involve
dozens or hundreds of applications built with all kinds of technologies.
@@ -55,144 +54,152 @@
or Twitter stream) can propagate updates to interested parties, including
Web applications that display that information in the real time.
-## Getting started with Ruby amqp gem ##
+## Getting started with Ruby amqp gem
-### Install RabbitMQ ###
+### Install RabbitMQ
Please refer to the [RabbitMQ installation guide](http://www.rabbitmq.com/install.html). Note that for Ubuntu and Debian we strongly advice that you
use [RabbitMQ apt repository](http://www.rabbitmq.com/debian.html#apt) that has recent versions of RabbitMQ. RabbitMQ packages Ubuntu and Debian ship
with are outdated even in recent (10.10) releases. Learn more in the [RabbitMQ versions guide](http://rubydoc.info/github/ruby-amqp/amqp/master/file/docs/RabbitMQVersions.textile).
-### Install the gem ###
+### Install the gem
On Microsoft Windows 7
- gem install eventmachine --pre
+ gem install eventmachine
gem install amqp
On other OSes or [JRuby](http://jruby.org):
gem install amqp
-### "Hello, World" example ###
+### "Hello, World" example
- #!/usr/bin/env ruby
- # encoding: utf-8
+``` ruby
+#!/usr/bin/env ruby
+# encoding: utf-8
- require "rubygems"
- # or
- #
- # require "bundler"
- # Bundler.setup
- #
- # if you use Bundler
+require "rubygems"
+# or
+#
+# require "bundler"
+# Bundler.setup
+#
+# if you use Bundler
- require 'amqp'
+require 'amqp'
- EventMachine.run do
- connection = AMQP.connect(:host => '127.0.0.1')
- puts "Connecting to AMQP broker. Running #{AMQP::VERSION} version of the gem..."
+EventMachine.run do
+ connection = AMQP.connect(:host => '127.0.0.1')
+ puts "Connecting to AMQP broker. Running #{AMQP::VERSION} version of the gem..."
- channel = AMQP::Channel.new(connection)
- queue = channel.queue("amqpgem.examples.hello_world", :auto_delete => true)
- exchange = channel.default_exchange
+ channel = AMQP::Channel.new(connection)
+ queue = channel.queue("amqpgem.examples.hello_world", :auto_delete => true)
+ exchange = channel.default_exchange
- queue.subscribe do |payload|
- puts "Received a message: #{payload}. Disconnecting..."
+ queue.subscribe do |payload|
+ puts "Received a message: #{payload}. Disconnecting..."
- connection.close {
- EventMachine.stop { exit }
- }
- end
+ connection.close {
+ EventMachine.stop { exit }
+ }
+ end
- exchange.publish "Hello, world!", :routing_key => queue.name
- end
+ exchange.publish "Hello, world!", :routing_key => queue.name
+end
+```
-[Getting started guide](http://bit.ly/getting-started-with-amqp-ruby-gem) explains this and two more examples in detail,
-and is written in a form of a tutorial. See [AMQP Model Explained](http://bit.ly/amqp-model-explained) if you want
+[Getting started guide](http://rubyamqp.info/articles/getting_started/) explains this and two more examples in detail,
+and is written in a form of a tutorial. See [AMQP Model Explained](http://www.rabbitmq.com/tutorials/amqp-concepts.html) if you want
to learn more about AMQP principles & concepts.
-## Documentation: tutorials, guides & API reference ##
+## Documentation: tutorials, guides & API reference
We believe that in order to be a library our users **really** love, we need to care about documentation as much as (or more)
code readability, API beauty and autotomated testing across 5 Ruby implementations on multiple operating systems. We do care
about our [documentation](http://rubyamqp.info): **if you don't find your answer in documentation, we consider it a high severity bug** that you
should [file to us](http://github.com/ruby-amqp/amqp/issues). Or just complain to [@rubyamqp](https://twitter.com/rubyamqp) on Twitter.
-### Tutorials ###
+### Tutorials
-[Getting started guide](http://bit.ly/getting-started-with-amqp-ruby-gem) is written as a tutorial that walks you through
+[Getting started guide](http://rubyamqp.info/articles/getting_started/) is written as a tutorial that walks you through
3 examples:
* The "Hello, world" of messaging, 1-to-1 communication
* Blabbr, a Twitter-like example of broadcasting (1-to-many communication)
* Weathr, an example of sophisticated routing capabilities AMQP 0.9.1 has to offer (1-to-many or many-to-many communication)
-all in under 20 minutes. [AMQP 0.9.1 Protocol Tutorial](http://bit.ly/amqp-model-explained) will introduce you to protocol concepts
+all in under 20 minutes. [AMQP 0.9.1 Concepts](http://www.rabbitmq.com/tutorials/amqp-concepts.html) will introduce you to protocol concepts
in less than 5 minutes.
-### Examples ###
+### Guides
+[Documentation guides](http://rubyamqp.info) describe the library itself as well as AMQP concepts, usage scenarios, topics like working with exchanges and queues,
+error handing & recovery, broker-specific extensions, TLS support, troubleshooting and so on. Most of the documentation is in these guides.
+
+
+### Examples
+
You can find many examples (both real-world cases and simple demonstrations) under [examples directory](https://github.com/ruby-amqp/amqp/tree/master/examples) in the repository.
Note that those examples are written against version 0.8.0.rc1 and later. 0.6.x and 0.7.x may not support certain AMQP protocol or "DSL syntax" features.
-There is also a work-in-progress [Messaging Patterns and Use Cases With AMQP](http://bit.ly/amqp-gem-patterns) documentation guide.
+There is also a work-in-progress [Messaging Patterns and Use Cases With AMQP](http://rubyamqp.info/articles/patterns_and_use_cases/) documentation guide.
-### Documentation guides ###
+### API reference
-[Documentation guides](http://rubyamqp.info) (also [on rubydoc.info](http://bit.ly/amqp-gem-docs)) describe the library itself as well as AMQP concepts, usage scenarios, topics like working with exchanges and queues,
-error handing & recovery, broker-specific extensions, TLS support, troubleshooting and so on. Most of the documentation is in these guides.
+[API reference](http://bit.ly/mDm1JE) is up on [rubydoc.info](http://rubydoc.info) and is updated daily.
-### API reference ###
-[API reference](http://bit.ly/mDm1JE) is up on [rubydoc.info](http://rubydoc.info) and is updated daily.
+## How to use AMQP gem with Ruby on Rails, Sinatra and other Web frameworks
+We cover Web application integration for multiple Ruby Web servers in [Connecting to the broker guide](http://rubyamqp.info/articles/connecting_to_broker/).
-## How to use AMQP gem with Ruby on Rails, Merb, Sinatra and other web frameworks ##
-We cover Web application integration for multiple Ruby Web servers in [Connecting to the broker guide](http://bit.ly/kFCVQU).
+## Community
+ * Join also [RabbitMQ mailing list](https://lists.rabbitmq.com/cgi-bin/mailman/listinfo/rabbitmq-discuss) (the AMQP community epicenter).
+ * Join [Ruby AMQP mailing list](http://groups.google.com/group/ruby-amqp)
+ * Follow [@rubyamqp](https://twitter.com/rubyamqp) on Twitter for Ruby AMQP ecosystem updates.
+ * Stop by #rabbitmq on irc.freenode.net. You can use [Web IRC client](http://webchat.freenode.net?channels=rabbitmq) if you don't have IRC client installed.
+
## Migration from amqp gem 0.6.x and 0.7.x
-Upgrading from amqp gem 0.6.x and 0.7.x to to 0.8.0.RCs is straightforward, please see [amqp gem 0.8.0 migration guide](http://bit.ly/amqp-gem-080-migration).
+Upgrading from amqp gem 0.6.x and 0.7.x to to 0.8.0.RCs is straightforward, please see [amqp gem 0.8.0 migration guide](http://rubyamqp.info/articles/08_migration/).
The same guide explains amqp gem versions history and why you would want to upgrade.
+
## Maintainer Information
amqp gem is maintained by [Michael Klishin](https://github.com/michaelklishin).
-## Community
+## Continuous Integration
- * Join [Ruby AMQP mailing list](http://groups.google.com/group/ruby-amqp)
- * Follow [@rubyamqp](https://twitter.com/rubyamqp) on Twitter for Ruby AMQP ecosystem updates.
- * Join also [RabbitMQ mailing list](https://lists.rabbitmq.com/cgi-bin/mailman/listinfo/rabbitmq-discuss) (AMQP community epicenter).
- * Stop by #rabbitmq on irc.freenode.net. You can use [Web IRC client](http://webchat.freenode.net?channels=rabbitmq) if you don't have IRC client installed.
+[](http://travis-ci.org/ruby-amqp/amqp)
-
## Links ##
* [API reference](http://rdoc.info/github/ruby-amqp/amqp/master/frames)
-* [Documentation guides](http://bit.ly/amqp-gem-docs)
-* [Code Examples](https://github.com/ruby-amqp/amq-protocol/tree/master/examples/)
+* [Documentation guides](http://rubyamqp.info)
+* [Code Examples](https://github.com/ruby-amqp/amqp/tree/master/examples)
* [Issue tracker](http://github.com/ruby-amqp/amqp/issues)
* [Continous integration status](http://travis-ci.org/#!/ruby-amqp/amqp)
## License ##
@@ -204,58 +211,59 @@
## Credits and copyright information ##
* The Original Code is [tmm1/amqp](http://github.com/tmm1/amqp).
* The Initial Developer of the Original Code is Aman Gupta.
* Copyright (c) 2008 - 2010 [Aman Gupta](http://github.com/tmm1).
-* Contributions from [Jakub Stastny](http://github.com/botanicus) are Copyright (c) 2011 VMware, Inc.
-* Copyright (c) 2010 — 2011 [ruby-amqp](https://github.com/ruby-amqp) group members.
+* Contributions from [Jakub Stastny](http://github.com/botanicus) are Copyright (c) 2011-2012 VMware, Inc.
+* Copyright (c) 2010 — 2012 [ruby-amqp](https://github.com/ruby-amqp) group members.
Currently maintained by [ruby-amqp](https://github.com/ruby-amqp) group members
Special thanks to Dmitriy Samovskiy, Ben Hood and Tony Garnock-Jones.
## How can I learn more about AMQP and messaging in general? ##
### AMQP resources ###
- * [AMQP 0.9.1 Model Explained](http://bit.ly/amqp-model-explained)
+ * [AMQP 0.9.1 Model Explained](http://www.rabbitmq.com/tutorials/amqp-concepts.html)
* [RabbitMQ tutorials](http://www.rabbitmq.com/getstarted.html) that demonstrate interoperability
* [Wikipedia page on AMQP](http://en.wikipedia.org/wiki/Advanced_Message_Queuing_Protocol)
* [AMQP quick reference](http://www.rabbitmq.com/amqp-0-9-1-quickref.html)
* John O'Hara on the [history of AMQP](http://www.acmqueue.org/modules.php?name=Content&pa=showpage&pid=485)
### Messaging and distributed systems resources ###
* [Enterprise Integration Patterns](http://www.eaipatterns.com), a book about messaging and use of messaging in systems integration.
-
* [A Critique of the Remote Procedure Call Paradigm](http://www.cs.vu.nl/~ast/publications/euteco-1988.pdf)
* [A Note on Distributed Computing](http://research.sun.com/techrep/1994/smli_tr-94-29.pdf)
* [Convenience Over Correctness](http://steve.vinoski.net/pdf/IEEE-Convenience_Over_Correctness.pdf)
* Joe Armstrong on [Erlang messaging vs RPC](http://armstrongonsoftware.blogspot.com/2008/05/road-we-didnt-go-down.html)
## (Very) Short FAQ ##
-### So, does amqp gem only work with RabbitMQ? ###
+### So, does amqp gem only work with RabbitMQ?
This library is developed and tested primarily with [RabbitMQ](http://rabbitmq.com), although it should be compatible with any
server implementing the [AMQP 0.9.1 spec](http://bit.ly/hw2ELX). For AMQP 0.8 brokers, use amqp gem version 0.7.x.
-### Why isn't Ruby 1.8.7.-p249 supported? Will it be supported in the future? ###
+### Why isn't Ruby 1.8.7-p249 supported? Will it be supported in the future?
In order to make code like the following (pseudo-synchronous) work
- conn = AMQP.connect
- ch = AMQP::Channel.new(conn)
+``` ruby
+conn = AMQP.connect
+ch = AMQP::Channel.new(conn)
- ex = ch.default_exchange
- ex.publish(some_data)
+ex = ch.default_exchange
+ex.publish(some_data)
+```
and not be affected by this [Ruby 1.8.7-p249-specific bug (super called outside of method)](http://bit.ly/iONBmH), we need to
avoid any inheritance for key amqp gem classes: Channel, Queue, Exchange, Consumer. This will take a significant refactoring effort and
we do not expect this to change at this time.
-### How does amqp gem relate to amq-client gem, amq-protocol and libraries like bunny? ###
+### How does amqp gem relate to amq-client gem, amq-protocol and libraries like Bunny?
See [this page about AMQP gems family](https://github.com/ruby-amqp/amq-client/blob/master/README.textile)