Module jakarta.messaging

Package jakarta.jms

Interface QueueReceiver

All Superinterfaces:

AutoCloseable, MessageConsumer

public interface QueueReceiver
extends MessageConsumer

A client uses a QueueReceiver object to receive messages that have been delivered to a queue.

Although it is possible to have multiple QueueReceivers for the same queue, the Jakarta Messaging API does not define how messages are distributed between the QueueReceivers.

If a QueueReceiver specifies a message selector, the messages that are not selected remain on the queue. By definition, a message selector allows a QueueReceiver to skip messages. This means that when the skipped messages are eventually read, the total ordering of the reads does not retain the partial order defined by each message producer. Only QueueReceivers without a message selector will read messages in message producer order.

Creating a MessageConsumer provides the same features as creating a QueueReceiver. A MessageConsumer object is recommended for creating new code. The QueueReceiver is provided to support existing code.

Since:

JMS 1.0

Version:

Jakarta Messaging 2.0

See Also:

• Session.createConsumer(Destination, String)
• Session.createConsumer(Destination)
• QueueSession.createReceiver(Queue, String)
• QueueSession.createReceiver(Queue)
• MessageConsumer

Method Summary

Modifier and Type	Method	Description
Queue	getQueue()	Gets the Queue associated with this queue receiver.

Methods inherited from interface jakarta.jms.MessageConsumer

close, getMessageListener, getMessageSelector, receive, receive, receiveNoWait, setMessageListener

Method Details

getQueue

Queue getQueue()
        throws JMSException

Gets the Queue associated with this queue receiver.

Returns:

this receiver's Queue

Throws:

JMSException - if the Jakarta Messaging provider fails to get the queue for this queue receiver due to some internal error.