Class: Qup::Consumer
- Inherits:
-
Object
- Object
- Qup::Consumer
- Defined in:
- lib/qup/consumer.rb
Overview
Public: Consumes items for a queue
A Consumer is created from a Queue and consumes messages from the queue.
Direct Known Subclasses
Instance Method Summary collapse
-
#acknowledge(message) ⇒ Object
Public: Acknowledge a consumed message.
-
#consume(&block) ⇒ Object
Public: Consume a message for the queue.
-
#initialize(queue) ⇒ Consumer
constructor
Public: Create a new Consumer.
Constructor Details
#initialize(queue) ⇒ Consumer
Public: Create a new Consumer
queue - the Queue this producer is for
Returns a new Consumer
13 14 15 |
# File 'lib/qup/consumer.rb', line 13 def initialize( queue ) @queue = queue end |
Instance Method Details
#acknowledge(message) ⇒ Object
Public: Acknowledge a consumed message
message - The message you are acknowledging
A consumed message must be acknowledge so the back end system can be assured that the message has been a fully processed.
Returns nothing.
38 39 40 |
# File 'lib/qup/consumer.rb', line 38 def acknowledge( ) @queue.acknowledge( ) end |
#consume(&block) ⇒ Object
Public: Consume a message for the queue
Yields the message
Most of the time you will want to call this message with a block as the Message will be auto-acknowledged. If you do not consume messages with a block, then you are required to acknowledge the messages on your own.
Returns a Message
26 27 28 |
# File 'lib/qup/consumer.rb', line 26 def consume(&block) @queue.consume(&block) end |