cms::Destination Class Reference

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

Inheritance diagram for cms::Destination:

[legend]

---

Detailed Description

A Destination object encapsulates a provider-specific address.

Public Types
enum	DestinationType { TOPIC, QUEUE, TEMPORARY_TOPIC, TEMPORARY_QUEUE }
Public Member Functions
virtual	~Destination ()
	Destructor.
virtual DestinationType	getDestinationType () const =0
	Retrieve the Destination Type for this Destination.
virtual std::string	toProviderString () const =0
	Converts the Destination to a String value representing the Provider specific name 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 Destinastion object to this one.
virtual const CMSProperties &	getCMSProperties () const =0
	Retrieve any properties that might be part of the destination that was specified.

---

Member Enumeration Documentation

enum cms::Destination::DestinationType

Enumerator:

TOPIC
QUEUE
TEMPORARY_TOPIC
TEMPORARY_QUEUE

---

Constructor & Destructor Documentation

virtual cms::Destination::~Destination

(

)

[inline, virtual]

Destructor.

---

Member Function Documentation

virtual DestinationType cms::Destination::getDestinationType

(

)

const [pure virtual]

Retrieve the Destination Type for this Destination.

Returns:

The Destination Type

virtual std::string cms::Destination::toProviderString

(

)

const [pure virtual]

Converts the Destination to a String value representing the Provider specific name for this destination.

This name must uniquely identify a particular destination. For example, a topic and a queue both named "FOO" must not have equivalent provider strings.

Returns:

Provider specific Name

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

virtual void cms::Destination::copy

(

const cms::Destination &

source

)

[pure virtual]

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

Parameters:

source

The source Destination object.

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:

const reference to a properties object.

---

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

• src/main/cms/Destination.h

---