javax::jms::QueueBrowser Class Reference

A client uses a QueueBrowser object to look at messages on a queue without removing them. More...

#include <javax_jms_QueueBrowser.h>

Inheritance diagram for javax::jms::QueueBrowser:

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

[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::QueueBrowser >	array1D
typedef ::xmog_java_array_template< ::xmog_java_array_template< ::javax::jms::QueueBrowser > >	array2D
Public Member Functions
virtual void	close (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Closes the QueueBrowser.
virtual ::java::util::Enumeration	getEnumeration (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Gets an enumeration for browsing the current queue messages in the order they would be received.
virtual ::java::lang::String	getMessageSelector (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Gets this queue browser's message selector expression.
virtual ::javax::jms::Queue	getQueue (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Gets the queue associated with this queue browser.

---

Detailed Description

A client uses a QueueBrowser object to look at messages on a queue without removing them.

The getEnumeration method returns a java.util.Enumeration that is used to scan the queue's messages. It may be an enumeration of the entire content of a queue, or it may contain only the messages matching a message selector.

Messages may be arriving and expiring while the scan is done. The JMS API does not require the content of an enumeration to be a static snapshot of queue content. Whether these changes are visible or not depends on the JMS provider.

A QueueBrowser can be created from either a Session or a QueueSession.

Author:

Mark Hapner

Rich Burridge

Kate Stout

---

Member Function Documentation

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

Closes the QueueBrowser. Since a provider may allocate some resources on behalf of a QueueBrowser 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. 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 ::java::util::Enumeration javax::jms::QueueBrowser::getEnumeration (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Gets an enumeration for browsing the current queue messages in the order they would be received. 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: an enumeration for browsing the messages

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

Gets this queue browser'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 queue browser'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::Queue javax::jms::QueueBrowser::getQueue (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Gets the queue associated with this queue browser. 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 queue

---

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

• javax_jms_QueueBrowser.h

---