|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mq.jms.MQMessageConsumer
MQMessageConsumer is the parent interface for all message consumers. A client uses a message consumer to receive messages from a Destination.
Method Summary | |
void |
close()
Closes the message consumer. |
javax.jms.Destination |
getDestination()
Gets the message destination. |
javax.jms.MessageListener |
getMessageListener()
Gets the message consumer's MessageListener. |
java.lang.String |
getMessageSelector()
Gets this message consumer's message selector expression. |
boolean |
getNoLocal()
Indicates whether locally published messages are inhibited. |
javax.jms.Message |
receive()
Receives the next message produced for this message consumer. |
javax.jms.Message |
receive(long timeout)
Receives the next message that arrives within the specified timeout interval. |
javax.jms.Message |
receiveNoWait()
Receives the next message if one is immediately available. |
void |
setMessageListener(javax.jms.MessageListener listener)
Sets the message consumer's MessageListener. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public java.lang.String getMessageSelector() throws javax.jms.JMSException
getMessageSelector
in interface javax.jms.MessageConsumer
javax.jms.JMSException
- with reason
MQJMS_MESSAGECONSUMER_CLOSED
public boolean getNoLocal() throws javax.jms.JMSException
javax.jms.JMSException
- with reason
MQJMS_MESSAGECONSUMER_CLOSED
public void setMessageListener(javax.jms.MessageListener listener) throws javax.jms.JMSException
setMessageListener
in interface javax.jms.MessageConsumer
listener
- the messages are delivered to this listener.
javax.jms.JMSException
- with one of the following reasons:
MessageConsumer.setMessageListener(javax.jms.MessageListener)
public void close() throws javax.jms.JMSException
close
in interface javax.jms.MessageConsumer
javax.jms.JMSException
- with one of the following reasons:
public javax.jms.MessageListener getMessageListener() throws javax.jms.JMSException
getMessageListener
in interface javax.jms.MessageConsumer
javax.jms.JMSException
- with reason
MQJMS_MESSAGECONSUMER_CLOSED
public javax.jms.Destination getDestination() throws javax.jms.JMSException
javax.jms.JMSException
- with reason
MQJMS_MESSAGECONSUMER_CLOSED
public javax.jms.Message receive() throws javax.jms.JMSException
This call blocks indefinitely until a message is produced or until this message consumer is closed.
If this receive() is done within a transaction, the consumer retains the message until the transaction commits.
receive
in interface javax.jms.MessageConsumer
javax.jms.JMSException
- if the JMS provider fails to receive the next
message due to an internal error.public javax.jms.Message receive(long timeout) throws javax.jms.JMSException
This call blocks until a message arrives, the timeout expires, or this message consumer is closed. A timeout of zero never expires, and the call blocks indefinitely.
receive
in interface javax.jms.MessageConsumer
timeout
- the timeout value (milliseconds)
javax.jms.JMSException
- if the JMS provider fails to receive the next
message due to an internal error.public javax.jms.Message receiveNoWait() throws javax.jms.JMSException
receiveNoWait
in interface javax.jms.MessageConsumer
javax.jms.JMSException
- if the JMS provider fails to receive the next
message due to an internal error.
|
(c) Copyright IBM Corp. 2005. All Rights Reserved. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |