activemq-cpp-3.9.5
activemq::commands::ActiveMQDestination Class Referenceabstract

#include <src/main/activemq/commands/ActiveMQDestination.h>

Inheritance diagram for activemq::commands::ActiveMQDestination:

Data Structures

struct  DestinationFilter
 

Public Types

typedef decaf::lang::PointerComparator< ActiveMQDestinationCOMPARATOR
 

Public Member Functions

 ActiveMQDestination ()
 
 ActiveMQDestination (const std::string &physicalName)
 
virtual ~ActiveMQDestination () throw ()
 
virtual ActiveMQDestinationcloneDataStructure () const
 Clone this obbject and return a new instance that the caller now owns, this will be an exact copy of this one.
 
virtual void copyDataStructure (const DataStructure *src)
 Copy the contents of the passed object into this objects members, overwriting any existing data.
 
virtual bool equals (const DataStructure *value) const
 Compares the DataStructure passed in to this one, and returns if they are equivalent.
 
virtual unsigned char getDataStructureType () const
 Get the DataStructure Type as defined in CommandTypes.h.
 
virtual std::string toString () const
 Returns a string containing the information for this DataStructure such as its type and value of its elements.
 
int getHashCode () const
 
virtual std::string getPhysicalName () const
 Fetch this destination's physical name.
 
virtual void setPhysicalName (const std::string &physicalName)
 Set this destination's physical name.
 
virtual bool isAdvisory () const
 
virtual void setAdvisory (bool advisory)
 
virtual bool isExclusive () const
 
virtual void setExclusive (bool exclusive)
 
virtual bool isOrdered () const
 
virtual void setOrdered (bool ordered)
 
virtual std::string getOrderedTarget () const
 
virtual void setOrderedTarget (const std::string &orderedTarget)
 
virtual cms::Destination::DestinationType getDestinationType () const =0
 Returns the Type of Destination that this object represents.
 
std::string getDestinationTypeAsString () const
 Returns the type of Destination that this object represents as a string, the available string values are, "Queue", "Topic", "TempQueue" and "TempTopic".
 
virtual bool isTemporary () const
 Returns true if a temporary Destination.
 
virtual bool isTopic () const
 Returns true if a Topic Destination.
 
virtual bool isQueue () const
 Returns true if a Queue Destination.
 
virtual bool isComposite () const
 Returns true if this destination represents a collection of destinations; allowing a set of destinations to be published to or subscribed from in one CMS operation.
 
decaf::util::ArrayList< Pointer< ActiveMQDestination > > getCompositeDestinations () const
 Returns an ArrayList containing all the ActiveMQDestinations that comprise this Composite destination, if this destination is composite, otherwise it returns an empty list.
 
virtual bool isWildcard () const
 
const activemq::util::ActiveMQPropertiesgetOptions () const
 
virtual const cms::DestinationgetCMSDestination () const
 
Pointer< ActiveMQDestinationcreateDestination (const std::string &name) const
 Create a new Destination that's of the same type as this one but with the given destination name.
 
virtual int compareTo (const ActiveMQDestination &value) const
 
virtual bool equals (const ActiveMQDestination &value) const
 
virtual bool operator== (const ActiveMQDestination &value) const
 
virtual bool operator< (const ActiveMQDestination &value) const
 
- Public Member Functions inherited from activemq::commands::BaseDataStructure
virtual ~BaseDataStructure ()
 
virtual bool isMarshalAware () const
 Determine if the class implementing this interface is really wanting to be told about marshaling.
 
virtual void beforeMarshal (wireformat::WireFormat *wireFormat AMQCPP_UNUSED)
 
virtual void afterMarshal (wireformat::WireFormat *wireFormat AMQCPP_UNUSED)
 
virtual void beforeUnmarshal (wireformat::WireFormat *wireFormat AMQCPP_UNUSED)
 
virtual void afterUnmarshal (wireformat::WireFormat *wireFormat AMQCPP_UNUSED)
 
virtual void setMarshaledForm (wireformat::WireFormat *wireFormat AMQCPP_UNUSED, const std::vector< char > &data AMQCPP_UNUSED)
 
virtual std::vector< unsigned char > getMarshaledForm (wireformat::WireFormat *wireFormat AMQCPP_UNUSED)
 
virtual void copyDataStructure (const DataStructure *src AMQCPP_UNUSED)
 
virtual bool equals (const DataStructure *value AMQCPP_UNUSED) const
 
- Public Member Functions inherited from activemq::commands::DataStructure
virtual ~DataStructure ()
 
- Public Member Functions inherited from activemq::wireformat::MarshalAware
virtual ~MarshalAware ()
 
virtual void beforeMarshal (WireFormat *wireFormat)=0
 Called before marshaling is started to prepare the object to be marshaled.
 
virtual void afterMarshal (WireFormat *wireFormat)=0
 Called after marshaling is started to cleanup the object being marshaled.
 
virtual void beforeUnmarshal (WireFormat *wireFormat)=0
 Called before unmarshaling is started to prepare the object to be unmarshaled.
 
virtual void afterUnmarshal (WireFormat *wireFormat)=0
 Called after unmarshaling is started to cleanup the object being unmarshaled.
 
virtual void setMarshaledForm (WireFormat *wireFormat, const std::vector< char > &data)=0
 Called to set the data to this object that will contain the objects marshaled form.
 
virtual std::vector< unsigned char > getMarshaledForm (WireFormat *wireFormat)=0
 Called to get the data to this object that will contain the objects marshaled form.
 
- Public Member Functions inherited from decaf::lang::Comparable< ActiveMQDestination >
virtual ~Comparable ()
 
virtual int compareTo (const ActiveMQDestination &value) const=0
 Compares this object with the specified object for order.
 
virtual bool equals (const ActiveMQDestination &value) const=0
 
virtual bool operator== (const ActiveMQDestination &value) const=0
 Compares equality between this object and the one passed.
 
virtual bool operator< (const ActiveMQDestination &value) const=0
 Compares this object to another and returns true if this object is considered to be less than the one passed.
 

Static Public Member Functions

static std::string createTemporaryName (const std::string &clientId)
 Create a temporary name from the clientId.
 
static std::string getClientId (const ActiveMQDestination *destination)
 From a temporary destination find the clientId of the Connection that created it.
 
static Pointer< ActiveMQDestinationcreateDestination (int type, const std::string &name)
 Creates a Destination given the String Name to use and a Type.
 

Static Public Attributes

static const unsigned char ID_ACTIVEMQDESTINATION = 0
 
static const std::string TEMP_DESTINATION_NAME_PREFIX
 

Protected Attributes

bool exclusive
 
bool ordered
 
bool advisory
 
decaf::util::ArrayList< Pointer< ActiveMQDestination > > compositeDestinations
 
std::string orderedTarget
 
std::string physicalName
 
util::ActiveMQProperties options
 
int hashCode
 

Static Protected Attributes

static const std::string DEFAULT_ORDERED_TARGET
 The default target for ordered destinations.
 
static const std::string TEMP_PREFIX
 
static const std::string TEMP_POSTFIX
 
static const std::string COMPOSITE_SEPARATOR
 
static const std::string QUEUE_QUALIFIED_PREFIX
 
static const std::string TOPIC_QUALIFIED_PREFIX
 
static const std::string TEMP_QUEUE_QUALIFED_PREFIX
 
static const std::string TEMP_TOPIC_QUALIFED_PREFIX
 

Member Typedef Documentation

◆ COMPARATOR

Constructor & Destructor Documentation

◆ ActiveMQDestination() [1/2]

activemq::commands::ActiveMQDestination::ActiveMQDestination ( )

◆ ActiveMQDestination() [2/2]

activemq::commands::ActiveMQDestination::ActiveMQDestination ( const std::string & physicalName)

References physicalName.

◆ ~ActiveMQDestination()

virtual activemq::commands::ActiveMQDestination::~ActiveMQDestination ( )
throw ( )
virtual

Member Function Documentation

◆ cloneDataStructure()

virtual ActiveMQDestination * activemq::commands::ActiveMQDestination::cloneDataStructure ( ) const
inlinevirtual

Clone this obbject and return a new instance that the caller now owns, this will be an exact copy of this one.

Returns
new copy of this object.

Implements activemq::commands::DataStructure.

Reimplemented in activemq::commands::ActiveMQQueue, activemq::commands::ActiveMQTempDestination, activemq::commands::ActiveMQTempQueue, activemq::commands::ActiveMQTempTopic, and activemq::commands::ActiveMQTopic.

References cloneDataStructure(), and NULL.

Referenced by cloneDataStructure().

◆ compareTo()

◆ copyDataStructure()

virtual void activemq::commands::ActiveMQDestination::copyDataStructure ( const DataStructure * src)
virtual

◆ createDestination() [1/2]

Pointer< ActiveMQDestination > activemq::commands::ActiveMQDestination::createDestination ( const std::string & name) const
inline

Create a new Destination that's of the same type as this one but with the given destination name.

Parameters
nameThe name
Returns
Pointer to a new ActiveMQDestination.

References createDestination(), and getDestinationType().

Referenced by createDestination().

◆ createDestination() [2/2]

static Pointer< ActiveMQDestination > activemq::commands::ActiveMQDestination::createDestination ( int type,
const std::string & name )
static

Creates a Destination given the String Name to use and a Type.

Parameters
type- The Type of Destination to Create
name- The Name to use in the creation of the Destination
Returns
Pointer to a new ActiveMQDestination instance.

◆ createTemporaryName()

static std::string activemq::commands::ActiveMQDestination::createTemporaryName ( const std::string & clientId)
inlinestatic

Create a temporary name from the clientId.

Parameters
clientId
Returns

References TEMP_POSTFIX, and TEMP_PREFIX.

◆ equals() [1/2]

◆ equals() [2/2]

virtual bool activemq::commands::ActiveMQDestination::equals ( const DataStructure * value) const
virtual

Compares the DataStructure passed in to this one, and returns if they are equivalent.

Equivalent here means that they are of the same type, and that each element of the objects are the same.

Returns
true if DataStructure's are Equal.

Implements activemq::commands::DataStructure.

Reimplemented in activemq::commands::ActiveMQQueue, activemq::commands::ActiveMQTempDestination, activemq::commands::ActiveMQTempQueue, activemq::commands::ActiveMQTempTopic, and activemq::commands::ActiveMQTopic.

Referenced by activemq::commands::ActiveMQTempDestination::equals(), activemq::commands::ActiveMQTempDestination::equals(), and activemq::commands::ActiveMQTempDestination::operator==().

◆ getClientId()

static std::string activemq::commands::ActiveMQDestination::getClientId ( const ActiveMQDestination * destination)
static

From a temporary destination find the clientId of the Connection that created it.

Parameters
destination
Returns
the clientId or null if not a temporary destination

◆ getCMSDestination()

virtual const cms::Destination * activemq::commands::ActiveMQDestination::getCMSDestination ( ) const
inlinevirtual
Returns
the cms::Destination interface pointer that the objects that derive from this class implement.

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

References NULL.

◆ getCompositeDestinations()

decaf::util::ArrayList< Pointer< ActiveMQDestination > > activemq::commands::ActiveMQDestination::getCompositeDestinations ( ) const

Returns an ArrayList containing all the ActiveMQDestinations that comprise this Composite destination, if this destination is composite, otherwise it returns an empty list.

◆ getDataStructureType()

virtual unsigned char activemq::commands::ActiveMQDestination::getDataStructureType ( ) const
virtual

◆ getDestinationType()

virtual cms::Destination::DestinationType activemq::commands::ActiveMQDestination::getDestinationType ( ) const
pure virtual

Returns the Type of Destination that this object represents.

Returns
int type qualifier.

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

Referenced by createDestination(), isTemporary(), and isTopic().

◆ getDestinationTypeAsString()

std::string activemq::commands::ActiveMQDestination::getDestinationTypeAsString ( ) const

Returns the type of Destination that this object represents as a string, the available string values are, "Queue", "Topic", "TempQueue" and "TempTopic".

Returns
The string value that represents the type of this destination.

◆ getHashCode()

int activemq::commands::ActiveMQDestination::getHashCode ( ) const
inline

◆ getOptions()

const activemq::util::ActiveMQProperties & activemq::commands::ActiveMQDestination::getOptions ( ) const
inline

◆ getOrderedTarget()

virtual std::string activemq::commands::ActiveMQDestination::getOrderedTarget ( ) const
inlinevirtual
Returns
Returns the orderedTarget.

References orderedTarget.

◆ getPhysicalName()

virtual std::string activemq::commands::ActiveMQDestination::getPhysicalName ( ) const
inlinevirtual

◆ isAdvisory()

virtual bool activemq::commands::ActiveMQDestination::isAdvisory ( ) const
inlinevirtual
Returns
Returns the advisory.

References advisory.

◆ isComposite()

virtual bool activemq::commands::ActiveMQDestination::isComposite ( ) const
inlinevirtual

Returns true if this destination represents a collection of destinations; allowing a set of destinations to be published to or subscribed from in one CMS operation.

Returns
true if this destination represents a collection of child destinations.

References COMPOSITE_SEPARATOR, and physicalName.

◆ isExclusive()

virtual bool activemq::commands::ActiveMQDestination::isExclusive ( ) const
inlinevirtual
Returns
Returns the exclusive.

References exclusive.

◆ isOrdered()

virtual bool activemq::commands::ActiveMQDestination::isOrdered ( ) const
inlinevirtual
Returns
Returns the ordered.

References ordered.

◆ isQueue()

virtual bool activemq::commands::ActiveMQDestination::isQueue ( ) const
inlinevirtual

Returns true if a Queue Destination.

Returns
true/false

References isTopic().

◆ isTemporary()

virtual bool activemq::commands::ActiveMQDestination::isTemporary ( ) const
inlinevirtual

Returns true if a temporary Destination.

Returns
true/false

References getDestinationType(), cms::Destination::TEMPORARY_QUEUE, and cms::Destination::TEMPORARY_TOPIC.

◆ isTopic()

virtual bool activemq::commands::ActiveMQDestination::isTopic ( ) const
inlinevirtual

Returns true if a Topic Destination.

Returns
true/false

References getDestinationType(), cms::Destination::TEMPORARY_TOPIC, and cms::Destination::TOPIC.

Referenced by isQueue().

◆ isWildcard()

virtual bool activemq::commands::ActiveMQDestination::isWildcard ( ) const
inlinevirtual

◆ operator<()

virtual bool activemq::commands::ActiveMQDestination::operator< ( const ActiveMQDestination & value) const
virtual

◆ operator==()

virtual bool activemq::commands::ActiveMQDestination::operator== ( const ActiveMQDestination & value) const
virtual

◆ setAdvisory()

virtual void activemq::commands::ActiveMQDestination::setAdvisory ( bool advisory)
inlinevirtual
Parameters
advisoryThe advisory to set.

References advisory.

◆ setExclusive()

virtual void activemq::commands::ActiveMQDestination::setExclusive ( bool exclusive)
inlinevirtual
Parameters
exclusiveThe exclusive to set.

References exclusive.

◆ setOrdered()

virtual void activemq::commands::ActiveMQDestination::setOrdered ( bool ordered)
inlinevirtual
Parameters
orderedThe ordered to set.

References ordered.

◆ setOrderedTarget()

virtual void activemq::commands::ActiveMQDestination::setOrderedTarget ( const std::string & orderedTarget)
inlinevirtual
Parameters
orderedTargetThe orderedTarget to set.

References orderedTarget.

◆ setPhysicalName()

virtual void activemq::commands::ActiveMQDestination::setPhysicalName ( const std::string & physicalName)
virtual

Set this destination's physical name.

Returns
const string containing the name

Reimplemented in activemq::commands::ActiveMQTempDestination.

References physicalName.

◆ toString()

virtual std::string activemq::commands::ActiveMQDestination::toString ( ) const
virtual

Returns a string containing the information for this DataStructure such as its type and value of its elements.

Returns
formatted string useful for debugging.

Reimplemented from activemq::commands::BaseDataStructure.

Reimplemented in activemq::commands::ActiveMQQueue, activemq::commands::ActiveMQTempDestination, activemq::commands::ActiveMQTempQueue, activemq::commands::ActiveMQTempTopic, and activemq::commands::ActiveMQTopic.

Field Documentation

◆ advisory

bool activemq::commands::ActiveMQDestination::advisory
protected

Referenced by isAdvisory(), and setAdvisory().

◆ COMPOSITE_SEPARATOR

const std::string activemq::commands::ActiveMQDestination::COMPOSITE_SEPARATOR
staticprotected

Referenced by isComposite().

◆ compositeDestinations

decaf::util::ArrayList< Pointer<ActiveMQDestination> > activemq::commands::ActiveMQDestination::compositeDestinations
mutableprotected

◆ DEFAULT_ORDERED_TARGET

const std::string activemq::commands::ActiveMQDestination::DEFAULT_ORDERED_TARGET
staticprotected

The default target for ordered destinations.

◆ exclusive

bool activemq::commands::ActiveMQDestination::exclusive
protected

Referenced by isExclusive(), and setExclusive().

◆ hashCode

int activemq::commands::ActiveMQDestination::hashCode
protected

◆ ID_ACTIVEMQDESTINATION

const unsigned char activemq::commands::ActiveMQDestination::ID_ACTIVEMQDESTINATION = 0
static

◆ options

util::ActiveMQProperties activemq::commands::ActiveMQDestination::options
protected

Referenced by getOptions().

◆ ordered

bool activemq::commands::ActiveMQDestination::ordered
protected

Referenced by isOrdered(), and setOrdered().

◆ orderedTarget

std::string activemq::commands::ActiveMQDestination::orderedTarget
protected

◆ physicalName

std::string activemq::commands::ActiveMQDestination::physicalName
protected

◆ QUEUE_QUALIFIED_PREFIX

const std::string activemq::commands::ActiveMQDestination::QUEUE_QUALIFIED_PREFIX
staticprotected

◆ TEMP_DESTINATION_NAME_PREFIX

const std::string activemq::commands::ActiveMQDestination::TEMP_DESTINATION_NAME_PREFIX
static

◆ TEMP_POSTFIX

const std::string activemq::commands::ActiveMQDestination::TEMP_POSTFIX
staticprotected

Referenced by createTemporaryName().

◆ TEMP_PREFIX

const std::string activemq::commands::ActiveMQDestination::TEMP_PREFIX
staticprotected

Referenced by createTemporaryName().

◆ TEMP_QUEUE_QUALIFED_PREFIX

const std::string activemq::commands::ActiveMQDestination::TEMP_QUEUE_QUALIFED_PREFIX
staticprotected

◆ TEMP_TOPIC_QUALIFED_PREFIX

const std::string activemq::commands::ActiveMQDestination::TEMP_TOPIC_QUALIFED_PREFIX
staticprotected

◆ TOPIC_QUALIFIED_PREFIX

const std::string activemq::commands::ActiveMQDestination::TOPIC_QUALIFIED_PREFIX
staticprotected

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