Consumer
| com.rabbitmq.client.Consumer |
 Known Indirect Subclasses
|
Class Overview
Interface for application callback objects to receive notifications and messages from
a queue by subscription.
Most implementations will subclass DefaultConsumer.
Connection's thread. This
allows Consumers to call Channel or Connection methods without causing a deadlock.
The Consumers on a particular Channel are invoked serially on one or more
dispatch threads. Consumers should avoid executing long-running code
because this will delay dispatch of messages to other Consumers on the same
Channel.
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Called when the consumer is cancelled for reasons other than by a call to
basicCancel(String). | |||||||||||
Called when the consumer is cancelled by a call to
basicCancel(String). | |||||||||||
Called when the consumer is registered by a call to any of the
basicConsume(String, boolean, Consumer) methods. | |||||||||||
Called when a
basic.deliver is received for this consumer. | |||||||||||
Called when a
basic.recover-ok is received
in reply to a basic.recover. | |||||||||||
Called when either the channel or the underlying connection has been shut down.
| |||||||||||
Public Methods
public abstract void handleCancel (String consumerTag)
Called when the consumer is cancelled for reasons other than by a call to
basicCancel(String). For example, the queue has been deleted.
See handleCancelOk(String) for notification of consumer
cancellation due to basicCancel(String).
Parameters
| consumerTag | the consumer tag associated with the consumer |
|---|
Throws
| IOException |
|---|
public abstract void handleCancelOk (String consumerTag)
Called when the consumer is cancelled by a call to basicCancel(String).
Parameters
| consumerTag | the consumer tag associated with the consumer |
|---|
public abstract void handleConsumeOk (String consumerTag)
Called when the consumer is registered by a call to any of the
basicConsume(String, boolean, Consumer) methods.
Parameters
| consumerTag | the consumer tag associated with the consumer |
|---|
public abstract void handleDelivery (String consumerTag, Envelope envelope, AMQP.BasicProperties properties, byte[] body)
Called when a basic.deliver is received for this consumer.
Parameters
| consumerTag | the consumer tag associated with the consumer |
|---|---|
| envelope | packaging data for the message |
| properties | content header data for the message |
| body | the message body (opaque, client-specific byte array) |
Throws
| IOException | if the consumer encounters an I/O error while processing the message |
|---|
See Also
public abstract void handleRecoverOk (String consumerTag)
Called when a basic.recover-ok is received
in reply to a basic.recover. All messages
received before this is invoked that haven't been ack'ed will be
re-delivered. All messages received afterwards won't be.
Parameters
| consumerTag | the consumer tag associated with the consumer |
|---|
public abstract void handleShutdownSignal (String consumerTag, ShutdownSignalException sig)
Called when either the channel or the underlying connection has been shut down.
Parameters
| consumerTag | the consumer tag associated with the consumer |
|---|---|
| sig | a ShutdownSignalException indicating the reason for the shut down
|