javax::jms::Topic Class Reference

A Topic object encapsulates a provider-specific topic name. More...

#include <javax_jms_Topic.h>

Inheritance diagram for javax::jms::Topic:

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

[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::Topic >	array1D
typedef ::xmog_java_array_template< ::xmog_java_array_template< ::javax::jms::Topic > >	array2D
Public Member Functions
virtual ::java::lang::String	getTopicName (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Gets the name of this topic.
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 Topic object encapsulates a provider-specific topic name.

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

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

Many publish/subscribe (pub/sub) providers group topics into hierarchies and provide various options for subscribing to parts of the hierarchy. The JMS API places no restriction on what a Topic object represents. It may be a leaf in a topic hierarchy, or it may be a larger part of the hierarchy.

The organization of topics and the granularity of subscriptions to them is an important part of a pub/sub application's architecture. The JMS API does not specify a policy for how this should be done. If an application takes advantage of a provider-specific topic-grouping mechanism, it should document this. If the application is installed using a different provider, it is the job of the administrator to construct an equivalent topic architecture and create equivalent Topic objects.

Author:

Mark Hapner

Rich Burridge

Kate Stout

---

Member Function Documentation

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

Gets the name of this topic. 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 topic name

virtual ::java::lang::String javax::jms::Topic::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 topic Reimplemented from java::lang::Object.

---

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

• javax_jms_Topic.h

---