Class: Bunny::Consumer

Inherits:
Object
  • Object
show all
Defined in:
lib/bunny/consumer.rb

Overview

Base class that represents consumer interface. Subclasses of this class implement specific logic of handling consumer life cycle events. Note that when the only event you are interested in is message deliveries, it is recommended to just use Queue#subscribe instead of subclassing this class.

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(channel, queue, consumer_tag = channel.generate_consumer_tag, no_ack = true, exclusive = false, arguments = {}) ⇒ Consumer

Returns a new instance of Consumer.

Parameters:

  • channel (Bunny::Channel) —

    Channel this consumer will use

  • queue (Bunny::Queue, String) —

    Queue messages will be consumed from

  • consumer_tag (String) (defaults to: channel.generate_consumer_tag) —

    Consumer tag (unique identifier). Generally it is better to let Bunny generate one. Empty string means RabbitMQ will generate consumer tag.

  • no_ack (Boolean) (defaults to: true) —

    (true) If true, delivered messages will be automatically acknowledged. If false, manual acknowledgements will be necessary.

  • exclusive (Boolean) (defaults to: false) —

    (false) Should this consumer be exclusive?

  • arguments (Hash) (defaults to: {}) —

    (nil) Optional arguments that may be used by RabbitMQ extensions, etc



36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/bunny/consumer.rb', line 36

def initialize(channel, queue, consumer_tag = channel.generate_consumer_tag, no_ack = true, exclusive = false, arguments = {})
  @channel       = channel || raise(ArgumentError, "channel is nil")
  @queue         = queue   || raise(ArgumentError, "queue is nil")
  @consumer_tag  = consumer_tag
  @exclusive     = exclusive
  @arguments     = arguments
  # no_ack set to true = no manual ack = automatic ack. MK.
  @no_ack        = no_ack

  @on_cancellation = []
end

Instance Attribute Details

#arguments ⇒ Object (readonly) 



22
23
24
 
# File 'lib/bunny/consumer.rb', line 22

def arguments
  @arguments
end

#channel ⇒ Object (readonly)

API



19
20
21
 
# File 'lib/bunny/consumer.rb', line 19

def channel
  @channel
end

#consumer_tag ⇒ Object 



21
22
23
 
# File 'lib/bunny/consumer.rb', line 21

def consumer_tag
  @consumer_tag
end

#exclusive ⇒ Object (readonly) 



24
25
26
 
# File 'lib/bunny/consumer.rb', line 24

def exclusive
  @exclusive
end

#no_ack ⇒ Object (readonly) 



23
24
25
 
# File 'lib/bunny/consumer.rb', line 23

def no_ack
  @no_ack
end

#queue ⇒ Object (readonly) 



20
21
22
 
# File 'lib/bunny/consumer.rb', line 20

def queue
  @queue
end

Instance Method Details

#automatic_acknowledgement? ⇒ Boolean

Returns true if this consumer uses automatic acknowledgement mode.

Returns:

  • (Boolean) —

    true if this consumer uses automatic acknowledgement mode



101
102
103
 
# File 'lib/bunny/consumer.rb', line 101

def automatic_acknowledgement?
  @no_ack
end

#cancel ⇒ Object

Cancels this consumer. Messages for this consumer will no longer be delivered. If the queue it was on is auto-deleted and this consumer was the last one, the queue will be deleted.

See Also:



85
86
87
 
# File 'lib/bunny/consumer.rb', line 85

def cancel
  @channel.basic_cancel(@consumer_tag)
end

#inspect ⇒ String

Returns More detailed human-readable string representation of this consumer.

Returns:

  • (String) —

    More detailed human-readable string representation of this consumer



90
91
92
 
# File 'lib/bunny/consumer.rb', line 90

def inspect
  "#<#{self.class.name}:#{object_id} @channel_id=#{@channel.number} @queue=#{self.queue_name} @consumer_tag=#{@consumer_tag} @exclusive=#{@exclusive} @no_ack=#{@no_ack}>"
end

#manual_acknowledgement? ⇒ Boolean

Returns true if this consumer uses manual (explicit) acknowledgement mode.

Returns:

  • (Boolean) —

    true if this consumer uses manual (explicit) acknowledgement mode



107
108
109
 
# File 'lib/bunny/consumer.rb', line 107

def manual_acknowledgement?
  !@no_ack
end

#on_cancellation(&block) ⇒ Object

Defines consumer cancellation notification handler

See Also:



67
68
69
70
 
# File 'lib/bunny/consumer.rb', line 67

def on_cancellation(&block)
  @on_cancellation << block
  self
end

#on_delivery(&block) ⇒ Object

Defines message delivery handler



50
51
52
53
 
# File 'lib/bunny/consumer.rb', line 50

def on_delivery(&block)
  @on_delivery = block
  self
end

#queue_name ⇒ String

Returns Name of the queue this consumer is on.

Returns:

  • (String) —

    Name of the queue this consumer is on



113
114
115
116
117
118
119
 
# File 'lib/bunny/consumer.rb', line 113

def queue_name
  if @queue.respond_to?(:name)
    @queue.name
  else
    @queue
  end
end

#to_s ⇒ String

Returns Brief human-readable string representation of this consumer.

Returns:

  • (String) —

    Brief human-readable string representation of this consumer



95
96
97
 
# File 'lib/bunny/consumer.rb', line 95

def to_s
  "#<#{self.class.name}:#{object_id} @channel_id=#{@channel.number} @queue=#{self.queue_name} @consumer_tag=#{@consumer_tag}>"
end