|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.codehaus.activemq.ActiveMQMessageConsumer
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 message consumer can be created with a message selector. A message selector allows the client to restrict the messages delivered to the message consumer to those that match the selector.
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 one of its
receive
methods. There are several variations of receive
that allow a client to poll or wait
for the next message.
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.
MessageConsumer
,
QueueReceiver
,
TopicSubscriber
,
Session
Field Summary | |
protected boolean |
browser
|
protected String |
consumerId
|
protected String |
consumerName
|
protected int |
consumerNumber
|
protected ActiveMQDestination |
destination
|
protected MemoryBoundedQueue |
messageQueue
|
protected String |
messageSelector
|
protected boolean |
noLocal
|
protected int |
prefetchNumber
|
protected ActiveMQSession |
session
|
protected long |
startTime
|
Constructor Summary | |
protected |
ActiveMQMessageConsumer(ActiveMQSession theSession,
ActiveMQDestination dest,
String name,
String selector,
int cnum,
int prefetch,
boolean noLocalValue,
boolean browserValue)
Create a MessageConsumer |
Method Summary | |
protected void |
checkClosed()
|
protected void |
clearMessagesInProgress()
|
void |
close()
Closes the message consumer. |
protected String |
getConsumerId()
|
protected String |
getConsumerName()
|
protected int |
getConsumerNumber()
|
JMSConsumerStatsImpl |
getConsumerStats()
|
protected ActiveMQDestination |
getDestination()
|
MessageListener |
getMessageListener()
Gets the message consumer's MessageListener . |
String |
getMessageSelector()
Gets this message consumer's message selector expression. |
int |
getPrefetchNumber()
|
protected long |
getStartTime()
|
Stats |
getStats()
|
protected boolean |
isBrowser()
Retrive is a browser |
boolean |
isDurableSubscriber()
|
protected boolean |
isNoLocal()
|
protected void |
processMessage(ActiveMQMessage message)
Process a Message - passing either to the queue or message listener |
Message |
receive()
Receives the next message produced for this message consumer. |
Message |
receive(long timeout)
Receives the next message that arrives within the specified timeout interval. |
Message |
receiveNoWait()
Receives the next message if one is immediately available. |
protected void |
setBrowser(boolean value)
Set true if only a Browser |
protected void |
setConsumerId(String consumerId)
|
protected void |
setConsumerName(String value)
Set the name of the Consumer - used for durable subscribers |
protected void |
setConsumerNumber(int value)
Set the locally unique consumer number |
void |
setMessageListener(MessageListener listener)
Sets the message consumer's MessageListener . |
void |
setPrefetchNumber(int prefetchNumber)
|
String |
toString()
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
protected ActiveMQSession session
protected String consumerId
protected MemoryBoundedQueue messageQueue
protected String messageSelector
protected String consumerName
protected ActiveMQDestination destination
protected int consumerNumber
protected int prefetchNumber
protected long startTime
protected boolean noLocal
protected boolean browser
Constructor Detail |
protected ActiveMQMessageConsumer(ActiveMQSession theSession, ActiveMQDestination dest, String name, String selector, int cnum, int prefetch, boolean noLocalValue, boolean browserValue) throws JMSException
theSession
- dest
- name
- selector
- cnum
- prefetch
- noLocalValue
- browserValue
-
JMSException
Method Detail |
public Stats getStats()
getStats
in interface StatsCapable
public JMSConsumerStatsImpl getConsumerStats()
public String toString()
public int getPrefetchNumber()
public void setPrefetchNumber(int prefetchNumber)
prefetchNumber
- The prefetchNumber to set.public String getMessageSelector() throws JMSException
getMessageSelector
in interface MessageConsumer
JMSException
- if the JMS provider fails to receive the next message due to some internal error.public MessageListener getMessageListener() throws JMSException
MessageListener
.
getMessageListener
in interface MessageConsumer
JMSException
- if the JMS provider fails to get the message listener due to some internal error.MessageConsumer.setMessageListener(javax.jms.MessageListener)
public void setMessageListener(MessageListener listener) throws JMSException
MessageListener
.
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.
setMessageListener
in interface MessageConsumer
listener
- the listener to which the messages are to be delivered
JMSException
- if the JMS provider fails to receive the next message due to some internal error.MessageConsumer.getMessageListener()
public Message receive() throws 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 MessageConsumer
JMSException
public Message receive(long timeout) throws 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 MessageConsumer
timeout
- the timeout value (in milliseconds)
JMSException
public Message receiveNoWait() throws JMSException
receiveNoWait
in interface MessageConsumer
JMSException
- if the JMS provider fails to receive the next message due to some internal error.public void close() throws JMSException
Since a provider may allocate some resources on behalf of a MessageConsumer
outside the Java
virtual machine, clients should close them when they are not needed. Relying on garbage collection to eventually
reclaim these resources may not be timely enough.
This call blocks until a receive
or message listener in progress has completed. A blocked message
consumer receive
call returns null when this message consumer is closed.
close
in interface MessageConsumer
JMSException
- if the JMS provider fails to close the consumer due to some internal error.public boolean isDurableSubscriber()
protected void checkClosed() throws IllegalStateException
IllegalStateException
protected void processMessage(ActiveMQMessage message)
message
- protected String getConsumerId()
protected void setConsumerId(String consumerId)
consumerId
- The consumerId to set.protected String getConsumerName()
protected void setConsumerName(String value)
value
- protected int getConsumerNumber()
protected void setConsumerNumber(int value)
value
- protected boolean isNoLocal()
protected boolean isBrowser()
protected void setBrowser(boolean value)
value
- ActiveMQQueueBrowser
protected ActiveMQDestination getDestination()
protected long getStartTime()
protected void clearMessagesInProgress()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |