March Hare: all documentation guides

Guide list

March Hare documentation is organized as a number of guides, covering all kinds of topics.

We recommend that you read these guides, if possible, in this order:

Getting started

An overview of March Hare with a quick tutorial that helps you to get started with it. It should take about 20 minutes to read and study the provided code examples.

AMQP 0.9.1 Model Concepts

This guide covers:

  • AMQP 0.9.1 model overview
  • What are channels
  • What are vhosts
  • What are queues
  • What are exchanges
  • What are bindings
  • What are AMQP 0.9.1 classes and methods

Connecting To RabbitMQ

This guide covers:

  • How to connect to RabbitMQ with March Hare
  • How to use connection URI to connect to RabbitMQ (also: in PaaS environments such as Heroku and CloudFoundry)
  • How to open a channel
  • How to close a channel
  • How to disconnect

Queues and Consumers

This guide covers:

  • How to declare AMQP queues with March Hare
  • Queue properties
  • How to declare server-named queues
  • How to declare temporary exclusive queues
  • How to consume messages ("push API")
  • How to fetch messages ("pull API")
  • Message and delivery properties
  • Message acknowledgements
  • How to purge queues
  • How to delete queues
  • Other topics related to queues

Exchanges and Publishing

This guide covers:

  • Exchange types
  • How to declare AMQP exchanges with March Hare
  • How to publish messages
  • Exchange propreties
  • Fanout exchanges
  • Direct exchanges
  • Topic exchanges
  • Default exchange
  • Message and delivery properties
  • Message routing
  • Bindings
  • How to delete exchanges
  • Other topics related to exchanges and publishing

Bindings

This guide covers:

  • How to bind exchanges to queues
  • How to unbind exchanges from queues
  • Other topics related to bindings

This guide covers:

  • Topics related to durability of exchanges and queues
  • Durability of messages

RabbitMQ Extensions to AMQP 0.9.1

This guide covers RabbitMQ extensions and how they are used in March Hare:

  • How to use Publishing Confirms with March Hare
  • How to use exchange-to-exchange bindings
  • How to the alternate exchange extension
  • How to set per-queue message TTL
  • How to set per-message TTL
  • What are consumer cancellation notifications and how to use them
  • Message dead lettering and the dead letter exchange
  • How to use sender-selected routing (CC and BCC headers)

Error Handling and Recovery

This guide covers:

  • AMQP 0.9.1 protocol exceptions
  • How to deal with network failures
  • Other things that may go wrong

Using TLS (SSL) Connections (TBD)

This guide covers:

  • How to use TLS (SSL) connections to RabbitMQ with March Hare

Troubleshooting

This guide covers:

  • What to check when your apps that use March Hare and RabbitMQ misbehave

Tell Us What You Think!

Please take a moment to tell us what you think about this guide on Twitter or the ruby-amqp mailing list.

Let us know what was unclear or what has not been covered. Maybe you do not like the guide style or grammar or discover spelling mistakes. Reader feedback is key to making the documentation better.