| SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A client uses a MessageConsumer object to receive messages
from a destination. A MessageConsumer object is created by
passing a Destination object to a message-consumer creation
method supplied by a session.
MessageConsumer is the parent interface for all message
consumers.
A client may either synchronously receive a message consumer's messages or have the consumer asynchronously deliver them as they arrive.
For synchronous receipt, a client can request the next message from a
message consumer using the receive method.
For asynchronous delivery, a client can register a
MessageListener object with a message consumer.
As messages arrive at the message consumer, it delivers them by calling the
MessageListener's onMessage method.
It is a client programming error for a MessageListener to
throw an exception.
| Constructor Summary | |
MessageConsumer()
A client uses a MessageConsumer object to receive messages
from a destination.
|
|
| Method Summary | |
VoidFuture
|
close(callback)
Closes the message consumer. |
MessageListener
|
getMessageListener()
Gets the message consumer's MessageListener.
|
String
|
getMessageSelector()
Gets this message consumer's message selector expression. |
Message
|
receiveNoWait()
Receives the next message if one is immediately available. |
void
|
setMessageListener(listener)
Sets the message consumer's MessageListener.
|
| Constructor Detail |
MessageConsumer()
MessageConsumer object to receive messages
from a destination. A MessageConsumer object is created by
passing a Destination object to a message-consumer creation
method supplied by a session.
MessageConsumer is the parent interface for all message
consumers.
A client may either synchronously receive a message consumer's messages or have the consumer asynchronously deliver them as they arrive.
For synchronous receipt, a client can request the next message from a
message consumer using the receive method.
For asynchronous delivery, a client can register a
MessageListener object with a message consumer.
As messages arrive at the message consumer, it delivers them by calling the
MessageListener's onMessage method.
It is a client programming error for a MessageListener to
throw an exception.
| Method Detail |
VoidFuture close(callback)
Since a provider may allocate some resources on behalf of a
MessageConsumer, clients should close them when they
are not needed.
This is an asynchronous call. The call returns immediately, but the
operation continues until outstanding message listeners or receives have
completed. The optional callback passed to close is called
when the consumer is finally closed.
Function callback - the callback to invoke when the close operation
has completed.
VoidFuture
JMSException if the JMS provider fails to close the consumer
due to some internal error.
MessageListener getMessageListener()
MessageListener.
MessageListener the listener for the message consumer, or null if no listener
is set
JMSException if the JMS provider fails to get the message
listener due to some internal error.
String getMessageSelector()
String this message consumer's message selector, or null if no
message selector exists for the message consumer (that is, if
the message selector was not set or was set to null or the
empty string)
JMSException if the JMS provider fails to get the message
selector due to some internal error.
Message receiveNoWait()
Message the next message produced for this message consumer, or
null if one is not available
JMSException if the JMS provider fails to receive the next
message due to some internal error.
void setMessageListener(listener)
MessageListener.
The message listener can either be a function or MessageListener.
A function passed as a message listener will act as a callback invoked with
incoming messages as the first parameter.
Setting the message listener to null is the equivalent of unsetting the message listener for the message consumer.
The effect of calling MessageConsumer.setMessageListener
while messages are being consumed by an existing listener
or the consumer is being used to consume messages synchronously
is undefined.
Function, MessageListener listener - the listener to which the messages are to be
delivered
void
JMSException if the JMS provider fails to set the message
listener due to some internal error.