com.rabbitmq.client

Class QueueingConsumer

java.lang.Object

com.rabbitmq.client.DefaultConsumer

com.rabbitmq.client.QueueingConsumer

All Implemented Interfaces:

Consumer

public class QueueingConsumer
extends DefaultConsumer

Convenience class: an implementation of Consumer with straightforward blocking semantics. The general pattern for using QueueingConsumer is as follows:

 // Create connection and channel.
 ConnectionFactory factory = new ConnectionFactory();
 Connection conn = factory.newConnection();
 Channel ch1 = conn.createChannel();

 // Declare a queue and bind it to an exchange.
 String queueName = ch1.queueDeclare().getQueue();
 ch1.queueBind(queueName, exchangeName, queueName);

 // Create the QueueingConsumer and have it consume from the queue
 QueueingConsumer consumer = new QueueingConsumer(ch1);
 ch1.basicConsume(queueName, false, consumer);

 // Process deliveries
 while (/* some condition * /) {
     QueueingConsumer.Delivery delivery = consumer.nextDelivery();
     // process delivery
     ch1.basicAck(delivery.getEnvelope().getDeliveryTag(), false);
 }
 

For a more detailed explanation, see the java api guide.

For a more complete example, see LogTail in the test/src/com/rabbitmq/examples directory of the source distribution.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueueingConsumer.Delivery Encapsulates an arbitrary message - simple "bean" holder structure.

Constructor Summary

Constructors

Constructor and Description
QueueingConsumer(Channel ch)
QueueingConsumer(Channel ch, java.util.concurrent.BlockingQueue<QueueingConsumer.Delivery> q)

Method Summary

Methods

Modifier and Type	Method and Description
void	handleCancel(java.lang.String consumerTag) No-op implementation of Consumer.handleCancel(String)
void	handleDelivery(java.lang.String consumerTag, Envelope envelope, AMQP.BasicProperties properties, byte[] body) No-op implementation of Consumer.handleDelivery(java.lang.String, com.rabbitmq.client.Envelope, com.rabbitmq.client.AMQP.BasicProperties, byte[]).
void	handleShutdownSignal(java.lang.String consumerTag, ShutdownSignalException sig) No-op implementation of Consumer.handleShutdownSignal(java.lang.String, com.rabbitmq.client.ShutdownSignalException).
QueueingConsumer.Delivery	nextDelivery() Main application-side API: wait for the next message delivery and return it.
QueueingConsumer.Delivery	nextDelivery(long timeout) Main application-side API: wait for the next message delivery and return it.

Methods inherited from class com.rabbitmq.client.DefaultConsumer

getChannel, getConsumerTag, handleCancelOk, handleConsumeOk, handleRecoverOk

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QueueingConsumer

public QueueingConsumer(Channel ch)

QueueingConsumer

public QueueingConsumer(Channel ch,
                java.util.concurrent.BlockingQueue<QueueingConsumer.Delivery> q)

Method Detail

handleShutdownSignal

public void handleShutdownSignal(java.lang.String consumerTag,
                        ShutdownSignalException sig)

Description copied from class: DefaultConsumer

No-op implementation of Consumer.handleShutdownSignal(java.lang.String, com.rabbitmq.client.ShutdownSignalException).

Specified by:

handleShutdownSignal in interface Consumer

Overrides:

handleShutdownSignal in class DefaultConsumer

Parameters:

consumerTag - the defined consumerTag (either client- or server-generated)

sig - an exception object encapsulating the reason for shutdown

handleCancel

public void handleCancel(java.lang.String consumerTag)
                  throws java.io.IOException

Description copied from class: DefaultConsumer

No-op implementation of Consumer.handleCancel(String)

Specified by:

handleCancel in interface Consumer

Overrides:

handleCancel in class DefaultConsumer

Parameters:

consumerTag - the defined consumer tag (client- or server-generated)

Throws:

java.io.IOException

handleDelivery

public void handleDelivery(java.lang.String consumerTag,
                  Envelope envelope,
                  AMQP.BasicProperties properties,
                  byte[] body)
                    throws java.io.IOException

Description copied from class: DefaultConsumer

No-op implementation of Consumer.handleDelivery(java.lang.String, com.rabbitmq.client.Envelope, com.rabbitmq.client.AMQP.BasicProperties, byte[]).

Specified by:

handleDelivery in interface Consumer

Overrides:

handleDelivery in class DefaultConsumer

Parameters:

consumerTag - the defined consumerTag (either client- or server-generated)

envelope - packaging data for the message

properties - content header data for the message

body - the message body (opaque client-specific byte array)

Throws:

java.io.IOException - if the consumer hits an I/O error while processing the message

nextDelivery

public QueueingConsumer.Delivery nextDelivery()
                                       throws java.lang.InterruptedException,
                                              ShutdownSignalException,
                                              ConsumerCancelledException

Main application-side API: wait for the next message delivery and return it.

Returns:

the next message

Throws:

java.lang.InterruptedException - if an interrupt is received while waiting

ShutdownSignalException - if the connection is shut down while waiting

ConsumerCancelledException

nextDelivery

public QueueingConsumer.Delivery nextDelivery(long timeout)
                                       throws java.lang.InterruptedException,
                                              ShutdownSignalException,
                                              ConsumerCancelledException

Main application-side API: wait for the next message delivery and return it.

Parameters:

timeout - timeout in millisecond

Returns:

the next message or null if timed out

Throws:

java.lang.InterruptedException - if an interrupt is received while waiting

ShutdownSignalException - if the connection is shut down while waiting

ConsumerCancelledException