activemq-cpp-3.9.0
cms::Topic Class Referenceabstract

An interface encapsulating a provider-specific topic name. More...

#include <src/main/cms/Topic.h>

Inheritance diagram for cms::Topic:

Public Member Functions

virtual ~Topic ()
 
virtual std::string getTopicName () const =0
 Gets the name of this topic. More...
 
- Public Member Functions inherited from cms::Destination
virtual ~Destination ()
 
virtual DestinationType getDestinationType () const =0
 Retrieve the Destination Type for this Destination. More...
 
virtual cms::Destinationclone () const =0
 Creates a new instance of this destination type that is a copy of this one, and returns it. More...
 
virtual void copy (const cms::Destination &source)=0
 Copies the contents of the given Destination object to this one. More...
 
virtual bool equals (const cms::Destination &other) const =0
 Compares two Destination instances to determine if they represent the same logic Destination. More...
 
virtual const CMSPropertiesgetCMSProperties () const =0
 Retrieve any properties that might be part of the destination that was specified. More...
 

Additional Inherited Members

- Public Types inherited from cms::Destination
enum  DestinationType { TOPIC, QUEUE, TEMPORARY_TOPIC, TEMPORARY_QUEUE }
 

Detailed Description

An interface encapsulating a provider-specific topic name.

A Topic is a Publish / Subscribe type Destination. All Messages sent to a Topic are broadcast to all Subscribers of that Topic unless the Subscriber defines a Message selector that filters out that Message.

Since
1.0

Constructor & Destructor Documentation

virtual cms::Topic::~Topic ( )
virtual

Member Function Documentation

virtual std::string cms::Topic::getTopicName ( ) const
pure virtual

Gets the name of this topic.

Returns
The topic name.
Exceptions
CMSException- If an internal error occurs.

Implemented in activemq::commands::ActiveMQTopic, and activemq::commands::ActiveMQTempTopic.


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