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

Inheritance diagram for activemq::commands::ActiveMQTempQueue:

Public Member Functions
	ActiveMQTempQueue ()
	ActiveMQTempQueue (const std::string &name)
virtual	~ActiveMQTempQueue () throw ()
virtual unsigned char	getDataStructureType () const
	Get the DataStructure Type as defined in CommandTypes.h.
virtual ActiveMQTempQueue *	cloneDataStructure () 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 std::string	toString () const
	Returns a string containing the information for this DataStructure such as its type and value of its elements.
virtual bool	equals (const DataStructure *value) const
	Compares the DataStructure passed in to this one, and returns if they are equivalent.
virtual const cms::Destination *	getCMSDestination () const
virtual cms::Destination::DestinationType	getDestinationType () const
	Returns the Type of Destination that this object represents.
virtual cms::Destination *	clone () const
	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)
	Copies the contents of the given Destination object to this one.
virtual const cms::CMSProperties &	getCMSProperties () const
	Retrieve any properties that might be part of the destination that was specified.
virtual bool	equals (const cms::Destination &other) const
	Compares two Destination instances to determine if they represent the same logic Destination.
virtual std::string	getQueueName () const
	Gets the name of this queue.
virtual void	destroy ()
	Destroy's the Temporary Destination at the Provider.
Public Member Functions inherited from activemq::commands::ActiveMQTempDestination
	ActiveMQTempDestination ()
	ActiveMQTempDestination (const std::string &name)
virtual	~ActiveMQTempDestination () throw ()
virtual void	close ()
	Closes this object and deallocates the appropriate resources.
virtual void	setPhysicalName (const std::string &physicalName)
	Set this destination's physical name.
void	setConnection (core::ActiveMQConnection *connection)
	Sets the Parent Connection that is notified when this destination is destroyed.
core::ActiveMQConnection *	getConnection () const
	Retrieves the Parent Connection that created this Connection.
std::string	getConnectionId () const
Public Member Functions inherited from activemq::commands::ActiveMQDestination
	ActiveMQDestination ()
	ActiveMQDestination (const std::string &physicalName)
virtual	~ActiveMQDestination () throw ()
virtual std::string	getPhysicalName () const
	Fetch 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)
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::ActiveMQProperties &	getOptions () const
Pointer< ActiveMQDestination >	createDestination (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.
Public Member Functions inherited from cms::Closeable
virtual	~Closeable ()
Public Member Functions inherited from cms::TemporaryQueue
virtual	~TemporaryQueue ()
Public Member Functions inherited from cms::Queue
virtual	~Queue ()
Public Member Functions inherited from cms::Destination
virtual	~Destination ()

Static Public Attributes
static const unsigned char	ID_ACTIVEMQTEMPQUEUE = 102
Static Public Attributes inherited from activemq::commands::ActiveMQTempDestination
static const unsigned char	ID_ACTIVEMQTEMPDESTINATION = 0
Static Public Attributes inherited from activemq::commands::ActiveMQDestination
static const unsigned char	ID_ACTIVEMQDESTINATION = 0

Additional Inherited Members
Public Types inherited from activemq::commands::ActiveMQDestination
typedef decaf::lang::PointerComparator < ActiveMQDestination >	COMPARATOR
Public Types inherited from cms::Destination
enum	DestinationType { TOPIC, QUEUE, TEMPORARY_TOPIC, TEMPORARY_QUEUE }
Static Public Member Functions inherited from activemq::commands::ActiveMQDestination
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 < ActiveMQDestination >	createDestination (int type, const std::string &name)
	Creates a Destination given the String Name to use and a Type.
Protected Attributes inherited from activemq::commands::ActiveMQTempDestination
core::ActiveMQConnection *	connection
	Connection that we call back on close to allow this resource to be cleaned up correctly at this end and at the Broker End.
std::string	connectionId
	The Connection Id of the Connection that created this Temporary Destination.
int	sequenceId
Static Protected Attributes inherited from activemq::commands::ActiveMQDestination
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

Constructor & Destructor Documentation

activemq::commands::ActiveMQTempQueue::ActiveMQTempQueue ( )

activemq::commands::ActiveMQTempQueue::ActiveMQTempQueue ( const std::string & name )

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

virtual

Member Function Documentation

virtual cms::Destination* activemq::commands::ActiveMQTempQueue::clone ( ) const

inlinevirtual

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

Returns: cloned copy of this object

Implements cms::Destination.

virtual ActiveMQTempQueue* activemq::commands::ActiveMQTempQueue::cloneDataStructure ( ) const

virtual

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.

Reimplemented from activemq::commands::ActiveMQTempDestination.

virtual void activemq::commands::ActiveMQTempQueue::copy ( const cms::Destination & source )

inlinevirtual

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

Parameters

source The source Destination object.

Implements cms::Destination.

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

virtual

Copy the contents of the passed object into this objects members, overwriting any existing data.

Returns: src - Source Object

Reimplemented from activemq::commands::ActiveMQTempDestination.

virtual void activemq::commands::ActiveMQTempQueue::destroy ( )

virtual

Destroy's the Temporary Destination at the Provider.

Exceptions

CMSException - if an internal error occurs.

Implements cms::TemporaryQueue.

virtual bool activemq::commands::ActiveMQTempQueue::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.

Reimplemented from activemq::commands::ActiveMQTempDestination.

virtual bool activemq::commands::ActiveMQTempQueue::equals ( const cms::Destination & other ) const

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.

Implements cms::Destination.

virtual const cms::Destination* activemq::commands::ActiveMQTempQueue::getCMSDestination ( ) const

inlinevirtual

Returns: the cms::Destination interface pointer that the objects that derive from this class implement.

Reimplemented from activemq::commands::ActiveMQDestination.

virtual const cms::CMSProperties& activemq::commands::ActiveMQTempQueue::getCMSProperties ( ) const

inlinevirtual

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.

Implements cms::Destination.

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

virtual

Get the DataStructure Type as defined in CommandTypes.h.

Returns: The type of the data structure

Reimplemented from activemq::commands::ActiveMQTempDestination.

virtual cms::Destination::DestinationType activemq::commands::ActiveMQTempQueue::getDestinationType ( ) const

inlinevirtual

Returns the Type of Destination that this object represents.

Returns: int type qualifier.

Implements activemq::commands::ActiveMQDestination.

References cms::Destination::TEMPORARY_QUEUE.

virtual std::string activemq::commands::ActiveMQTempQueue::getQueueName ( ) const

inlinevirtual

Gets the name of this queue.

Returns: The queue name.

Exceptions

CMSException - If an internal error occurs.

Implements cms::Queue.

virtual std::string activemq::commands::ActiveMQTempQueue::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::ActiveMQTempDestination.

Field Documentation

const unsigned char activemq::commands::ActiveMQTempQueue::ID_ACTIVEMQTEMPQUEUE = 102

static

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

src/main/activemq/commands/ActiveMQTempQueue.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation