javax::jms::MessageConsumer Class Reference

A client uses a MessageConsumer object to receive messages from a destination. More...

#include <javax_jms_MessageConsumer.h>

Inheritance diagram for javax::jms::MessageConsumer:

[legend]Collaboration diagram for javax::jms::MessageConsumer:

[legend]List of all members.

Public Types
enum	{   xmogDefaultFlags = xmog_base::GLOBAL, xmogMajorVersion = 3, xmogMinorVersion = 2, xmogPatchVersion = 9,   xmogBuildNumber = 2047 }
typedef ::xmog_java_array_template< ::javax::jms::MessageConsumer >	array1D
typedef ::xmog_java_array_template< ::xmog_java_array_template< ::javax::jms::MessageConsumer > >	array2D
Public Member Functions
virtual void	close (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Closes the message consumer.
virtual ::javax::jms::MessageListener	getMessageListener (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Gets the message consumer's MessageListener.
virtual ::java::lang::String	getMessageSelector (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Gets this message consumer's message selector expression.
virtual ::javax::jms::Message	receive (jlong timeout,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Receives the next message that arrives within the specified timeout interval.
virtual ::javax::jms::Message	receive (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Receives the next message produced for this message consumer.
virtual ::javax::jms::Message	receiveNoWait (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Receives the next message if one is immediately available.
virtual void	setMessageListener (const ::javax::jms::MessageListener &listener,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Sets the message consumer's MessageListener.

---

Detailed Description

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.

Author:

Mark Hapner

Rich Burridge

---

Member Function Documentation

virtual void javax::jms::MessageConsumer::close (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Closes the message consumer. 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. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

virtual ::javax::jms::MessageListener javax::jms::MessageConsumer::getMessageListener (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Gets the message consumer's MessageListener. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the listener for the message consumer, or null if no listener is set

virtual ::java::lang::String javax::jms::MessageConsumer::getMessageSelector (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Gets this message consumer's message selector expression. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: 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)

virtual ::javax::jms::Message javax::jms::MessageConsumer::receive (  jlong  timeout, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Receives the next message that arrives within the specified timeout interval. 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. Parameters: timeout  the timeout value (in milliseconds) p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the next message produced for this message consumer, or null if the timeout expires or this message consumer is concurrently closed

virtual ::javax::jms::Message javax::jms::MessageConsumer::receive (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Receives the next message produced for this message consumer. 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. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the next message produced for this message consumer, or null if this message consumer is concurrently closed

virtual ::javax::jms::Message javax::jms::MessageConsumer::receiveNoWait (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Receives the next message if one is immediately available. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the next message produced for this message consumer, or null if one is not available

virtual void javax::jms::MessageConsumer::setMessageListener (  const ::javax::jms::MessageListener &  listener, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Sets the message consumer's 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. Parameters: listener  the listener to which the messages are to be delivered p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

---

The documentation for this class was generated from the following file:

• javax_jms_MessageConsumer.h

---