File: guides.md

package info (click to toggle)
ruby-bunny 2.23.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,644 kB
  • sloc: ruby: 10,256; sh: 70; makefile: 8
file content (149 lines) | stat: -rw-r--r-- 3,960 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
---
title: "Bunny: all documentation guides"
layout: article
---

## Guide list

[Bunny documentation](https://github.com/ruby-amqp/rubybunny.info) 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](/articles/getting_started.html)

An overview of Bunny 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](http://www.rabbitmq.com/tutorials/amqp-concepts.html)

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](/articles/connecting.html)

This guide covers:

 * How to connect to RabbitMQ with Bunny 0.9+
 * 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](/articles/queues.html)

This guide covers:

 * How to declare AMQP queues with Bunny
 * 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](/articles/exchanges.html)

This guide covers:

 * Exchange types
 * How to declare AMQP exchanges with Bunny
 * How to publish messages
 * Exchange properties
 * 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](/articles/bindings.html)

This guide covers:

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


### [Durability and Related Matters](/articles/durability.html)

This guide covers:

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


### [Concurrency Considerations](/articles/concurrency.html)

This guide covers:

 * Concurrency in Bunny
 * Correctness and concurrency safety of key public API classes and methods
 * Other topics related to concurrency



### [RabbitMQ Extensions to AMQP 0.9.1](/articles/extensions.html)

This guide covers [RabbitMQ extensions](http://www.rabbitmq.com/extensions.html) and how they are used in Bunny:

 * How to use Publishing Confirms with Bunny
 * 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](/articles/error_handling.html)

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](/articles/tls.html)

This guide covers:

 * How to use TLS (SSL) connections to RabbitMQ with Bunny



### [Troubleshooting](/articles/troubleshooting.html)

This guide covers:

 * What to check when your apps that use Bunny 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](https://groups.google.com/forum/?fromgroups#!forum/ruby-amqp)

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.