javax::jms::Queue Class Reference

A Queue object encapsulates a provider-specific queue name. More...

#include <javax_jms_Queue.h>

Inheritance diagram for javax::jms::Queue:

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

[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::Queue >	array1D
typedef ::xmog_java_array_template< ::xmog_java_array_template< ::javax::jms::Queue > >	array2D
Public Member Functions
virtual ::java::lang::String	getQueueName (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Gets the name of this queue.
virtual ::java::lang::String	toString (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a string representation of this object.

---

Detailed Description

A Queue object encapsulates a provider-specific queue name.

It is the way a client specifies the identity of a queue to JMS API methods. For those methods that use a Destination as a parameter, a Queue object used as an argument. For example, a queue can be used to create a MessageConsumer and a MessageProducer by calling:

• Session.CreateConsumer(Destination destination)
• Session.CreateProducer(Destination destination)

The actual length of time messages are held by a queue and the consequences of resource overflow are not defined by the JMS API.

Author:

Mark Hapner

Rich Burridge

Kate Stout

---

Member Function Documentation

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

Gets the name of this queue. Clients that depend upon the name are not portable. 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 name

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

Returns a string representation of this object. 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 provider-specific identity values for this queue Reimplemented from java::lang::Object.

---

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

• javax_jms_Queue.h

---