cms::Destination Class Reference

A Destination object encapsulates a provider-specific address. More...

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

Inheritance diagram for cms::Destination:

Public Types
enum	DestinationType { TOPIC, QUEUE, TEMPORARY_TOPIC, TEMPORARY_QUEUE }

Public Member Functions
virtual	~Destination ()
virtual DestinationType	getDestinationType () const =0
	Retrieve the Destination Type for this Destination.
virtual cms::Destination *	clone () const =0
	Creates a new instance of this destination type that is a copy of this one, and returns it.
virtual void	copy (const cms::Destination &source)=0
	Copies the contents of the given Destination object to this one.
virtual bool	equals (const cms::Destination &other) const =0
	Compares two Destination instances to determine if they represent the same logic Destination.
virtual const CMSProperties &	getCMSProperties () const =0
	Retrieve any properties that might be part of the destination that was specified.

Detailed Description

A Destination object encapsulates a provider-specific address.

There is no standard definition of a Destination address, each provider can provide its own definition and there can be configuration data attached to the Destination address.

All CMS Destination objects support concurrent use.

Since

1.0

Member Enumeration Documentation

enum cms::Destination::DestinationType

Enumerator:

TOPIC
QUEUE
TEMPORARY_TOPIC
TEMPORARY_QUEUE

Constructor & Destructor Documentation

virtual cms::Destination::~Destination ( )

virtual

Member Function Documentation

virtual cms::Destination* cms::Destination::clone ( ) const

pure virtual

Creates a new instance of this destination type that is a copy of this one, and returns it.

Returns

cloned copy of this object

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

Referenced by activemq::commands::ActiveMQMessageTemplate< cms::ObjectMessage >::setCMSDestination(), and activemq::commands::ActiveMQMessageTemplate< cms::ObjectMessage >::setCMSReplyTo().

virtual void cms::Destination::copy ( const cms::Destination &  source )

pure virtual

Copies the contents of the given Destination object to this one.

Parameters

source

The source Destination object.

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

virtual bool cms::Destination::equals ( const cms::Destination &  other ) const

pure virtual

Compares two Destination instances to determine if they represent the same logic Destination.

Parameters

other

The other destination to compare this one to.

Returns

true if the two destinations are the same.

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

virtual const CMSProperties& cms::Destination::getCMSProperties ( ) const

pure virtual

Retrieve any properties that might be part of the destination that was specified.

This is a deviation from the JMS spec but necessary due to C++ restrictions.

Returns

A {const} reference to a CMSProperties object.

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

virtual DestinationType cms::Destination::getDestinationType ( ) const

pure virtual

Retrieve the Destination Type for this Destination.

Returns

The Destination Type

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

---

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

• src/main/cms/Destination.h