-
Notifications
You must be signed in to change notification settings - Fork 304
/
queue.rb
393 lines (334 loc) · 13.1 KB
/
queue.rb
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
require "bunny/get_response"
module Bunny
# Represents AMQP 0.9.1 queue.
#
# @see http://rubybunny.info/articles/queues.html Queues and Consumers guide
# @see http://rubybunny.info/articles/extensions.html RabbitMQ Extensions guide
class Queue
#
# API
#
# @return [Bunny::Channel] Channel this queue uses
attr_reader :channel
# @return [String] Queue name
attr_reader :name
# @return [Hash] Options this queue was created with
attr_reader :options
# @param [Bunny::Channel] channel Channel this queue will use.
# @param [String] name Queue name. Pass an empty string to make RabbitMQ generate a unique one.
# @param [Hash] opts Queue properties
#
# @option opts [Boolean] :durable (false) Should this queue be durable?
# @option opts [Boolean] :auto_delete (false) Should this queue be automatically deleted when the last consumer disconnects?
# @option opts [Boolean] :exclusive (false) Should this queue be exclusive (only can be used by this connection, removed when the connection is closed)?
# @option opts [Hash] :arguments ({}) Additional optional arguments (typically used by RabbitMQ extensions and plugins)
#
# @see Bunny::Channel#queue
# @see http://rubybunny.info/articles/queues.html Queues and Consumers guide
# @see http://rubybunny.info/articles/extensions.html RabbitMQ Extensions guide
# @api public
def initialize(channel, name = AMQ::Protocol::EMPTY_STRING, opts = {})
# old Bunny versions pass a connection here. In that case,
# we just use default channel from it. MK.
@channel = channel
@name = name
@options = self.class.add_default_options(name, opts)
@durable = @options[:durable]
@exclusive = @options[:exclusive]
@server_named = @name.empty?
@auto_delete = @options[:auto_delete]
@arguments = @options[:arguments]
@bindings = Array.new
@default_consumer = nil
declare! unless opts[:no_declare]
@channel.register_queue(self)
end
# @return [Boolean] true if this queue was declared as durable (will survive broker restart).
# @api public
# @see http://rubybunny.info/articles/queues.html Queues and Consumers guide
def durable?
@durable
end # durable?
# @return [Boolean] true if this queue was declared as exclusive (limited to just one consumer)
# @api public
# @see http://rubybunny.info/articles/queues.html Queues and Consumers guide
def exclusive?
@exclusive
end # exclusive?
# @return [Boolean] true if this queue was declared as automatically deleted (deleted as soon as last consumer unbinds).
# @api public
# @see http://rubybunny.info/articles/queues.html Queues and Consumers guide
def auto_delete?
@auto_delete
end # auto_delete?
# @return [Boolean] true if this queue was declared as server named.
# @api public
# @see http://rubybunny.info/articles/queues.html Queues and Consumers guide
def server_named?
@server_named
end # server_named?
# @return [Hash] Additional optional arguments (typically used by RabbitMQ extensions and plugins)
# @api public
def arguments
@arguments
end
def to_s
oid = ("0x%x" % (self.object_id << 1))
"<#{self.class.name}:#{oid} @name=\"#{name}\" channel=#{@channel.to_s} @durable=#{@durable} @auto_delete=#{@auto_delete} @exclusive=#{@exclusive} @arguments=#{@arguments}>"
end
def inspect
to_s
end
# Binds queue to an exchange
#
# @param [Bunny::Exchange,String] exchange Exchange to bind to
# @param [Hash] opts Binding properties
#
# @option opts [String] :routing_key Routing key
# @option opts [Hash] :arguments ({}) Additional optional binding arguments
#
# @see http://rubybunny.info/articles/queues.html Queues and Consumers guide
# @see http://rubybunny.info/articles/bindings.html Bindings guide
# @api public
def bind(exchange, opts = {})
@channel.queue_bind(@name, exchange, opts)
exchange_name = if exchange.respond_to?(:name)
exchange.name
else
exchange
end
# store bindings for automatic recovery. We need to be very careful to
# not cause an infinite rebinding loop here when we recover. MK.
binding = { :exchange => exchange_name, :routing_key => (opts[:routing_key] || opts[:key]), :arguments => opts[:arguments] }
@bindings.push(binding) unless @bindings.include?(binding)
self
end
# Unbinds queue from an exchange
#
# @param [Bunny::Exchange,String] exchange Exchange to unbind from
# @param [Hash] opts Binding properties
#
# @option opts [String] :routing_key Routing key
# @option opts [Hash] :arguments ({}) Additional optional binding arguments
#
# @see http://rubybunny.info/articles/queues.html Queues and Consumers guide
# @see http://rubybunny.info/articles/bindings.html Bindings guide
# @api public
def unbind(exchange, opts = {})
@channel.queue_unbind(@name, exchange, opts)
exchange_name = if exchange.respond_to?(:name)
exchange.name
else
exchange
end
@bindings.delete_if { |b| b[:exchange] == exchange_name && b[:routing_key] == (opts[:routing_key] || opts[:key]) && b[:arguments] == opts[:arguments] }
self
end
# Adds a consumer to the queue (subscribes for message deliveries).
#
# @param [Hash] opts Options
#
# @option opts [Boolean] :ack (false) [DEPRECATED] Use :manual_ack instead
# @option opts [Boolean] :manual_ack (false) Will this consumer use manual acknowledgements?
# @option opts [Boolean] :exclusive (false) Should this consumer be exclusive for this queue?
# @option opts [#call] :on_cancellation Block to execute when this consumer is cancelled remotely (e.g. via the RabbitMQ Management plugin)
# @option opts [String] :consumer_tag Unique consumer identifier. It is usually recommended to let Bunny generate it for you.
# @option opts [Hash] :arguments ({}) Additional (optional) arguments, typically used by RabbitMQ extensions
#
# @see http://rubybunny.info/articles/queues.html Queues and Consumers guide
# @api public
def subscribe(opts = {
:consumer_tag => @channel.generate_consumer_tag,
:manual_ack => false,
:exclusive => false,
:block => false,
:on_cancellation => nil
}, &block)
unless opts[:ack].nil?
warn "[DEPRECATION] `:ack` is deprecated. Please use `:manual_ack` instead."
opts[:manual_ack] = opts[:ack]
end
ctag = opts.fetch(:consumer_tag, @channel.generate_consumer_tag)
consumer = Consumer.new(@channel,
self,
ctag,
!opts[:manual_ack],
opts[:exclusive],
opts[:arguments])
consumer.on_delivery(&block)
consumer.on_cancellation(&opts[:on_cancellation]) if opts[:on_cancellation]
@channel.basic_consume_with(consumer)
if opts[:block]
# joins current thread with the consumers pool, will block
# the current thread for as long as the consumer pool is active
@channel.work_pool.join
end
consumer
end
# Adds a consumer object to the queue (subscribes for message deliveries).
#
# @param [Bunny::Consumer] consumer a {Bunny::Consumer} subclass that implements consumer interface
# @param [Hash] opts Options
#
# @option opts [Boolean] block (false) Should the call block calling thread?
#
# @see http://rubybunny.info/articles/queues.html Queues and Consumers guide
# @api public
def subscribe_with(consumer, opts = {:block => false})
@channel.basic_consume_with(consumer)
@channel.work_pool.join if opts[:block]
consumer
end
# @param [Hash] opts Options
#
# @option opts [Boolean] :ack (false) [DEPRECATED] Use :manual_ack instead
# @option opts [Boolean] :manual_ack (false) Will the message be acknowledged manually?
#
# @return [Array] Triple of delivery info, message properties and message content.
# If the queue is empty, all three will be nils.
# @see http://rubybunny.info/articles/queues.html Queues and Consumers guide
# @see Bunny::Queue#subscribe
# @api public
#
# @example
# conn = Bunny.new
# conn.start
#
# ch = conn.create_channel
# q = ch.queue("test1")
# x = ch.default_exchange
# x.publish("Hello, everybody!", :routing_key => 'test1')
#
# delivery_info, properties, payload = q.pop
#
# puts "This is the message: " + payload + "\n\n"
# conn.close
def pop(opts = {:manual_ack => false}, &block)
unless opts[:ack].nil?
warn "[DEPRECATION] `:ack` is deprecated. Please use `:manual_ack` instead."
opts[:manual_ack] = opts[:ack]
end
get_response, properties, content = @channel.basic_get(@name, opts)
if block
if properties
di = GetResponse.new(get_response, @channel)
mp = MessageProperties.new(properties)
block.call(di, mp, content)
else
block.call(nil, nil, nil)
end
else
if properties
di = GetResponse.new(get_response, @channel)
mp = MessageProperties.new(properties)
[di, mp, content]
else
[nil, nil, nil]
end
end
end
alias get pop
# Publishes a message to the queue via default exchange. Takes the same arguments
# as {Bunny::Exchange#publish}
#
# @see Bunny::Exchange#publish
# @see Bunny::Channel#default_exchange
# @see http://rubybunny.info/articles/exchanges.html Exchanges and Publishing guide
def publish(payload, opts = {})
@channel.default_exchange.publish(payload, opts.merge(:routing_key => @name))
self
end
# Deletes the queue
#
# @param [Hash] opts Options
#
# @option opts [Boolean] if_unused (false) Should this queue be deleted only if it has no consumers?
# @option opts [Boolean] if_empty (false) Should this queue be deleted only if it has no messages?
#
# @see http://rubybunny.info/articles/queues.html Queues and Consumers guide
# @api public
def delete(opts = {})
@channel.deregister_queue(self)
@channel.queue_delete(@name, opts)
end
# Purges a queue (removes all messages from it)
# @see http://rubybunny.info/articles/queues.html Queues and Consumers guide
# @api public
def purge(opts = {})
@channel.queue_purge(@name, opts)
self
end
# @return [Hash] A hash with information about the number of queue messages and consumers
# @see #message_count
# @see #consumer_count
def status
queue_declare_ok = @channel.queue_declare(@name, @options.merge(:passive => true))
{:message_count => queue_declare_ok.message_count,
:consumer_count => queue_declare_ok.consumer_count}
end
# @return [Integer] How many messages the queue has ready (e.g. not delivered but not unacknowledged)
def message_count
s = self.status
s[:message_count]
end
# @return [Integer] How many active consumers the queue has
def consumer_count
s = self.status
s[:consumer_count]
end
#
# Recovery
#
# @private
def recover_from_network_failure
if self.server_named?
old_name = @name.dup
@name = AMQ::Protocol::EMPTY_STRING
@channel.deregister_queue_named(old_name)
end
# TODO: inject and use logger
# puts "Recovering queue #{@name}"
begin
declare! unless @options[:no_declare]
@channel.register_queue(self)
rescue Exception => e
# TODO: inject and use logger
puts "Caught #{e.inspect} while redeclaring and registering #{@name}!"
end
recover_bindings
end
# @private
def recover_bindings
@bindings.each do |b|
# TODO: inject and use logger
# puts "Recovering binding #{b.inspect}"
self.bind(b[:exchange], b)
end
end
#
# Implementation
#
# @private
def declare!
queue_declare_ok = @channel.queue_declare(@name, @options)
@name = queue_declare_ok.queue
end
protected
# @private
def self.add_default_options(name, opts)
# :nowait is always false for Bunny
h = { :queue => name, :nowait => false }.merge(opts)
if name.empty?
{
:passive => false,
:durable => false,
:exclusive => false,
:auto_delete => false,
:arguments => nil
}.merge(h)
else
h
end
end
end
end