activemq::commands::ActiveMQQueue Class Reference
#include <src/main/activemq/commands/ActiveMQQueue.h>
Public Member Functions | |
| ActiveMQQueue () | |
| ActiveMQQueue (const std::string &name) | |
| virtual | ~ActiveMQQueue () throw () |
| virtual unsigned char | getDataStructureType () const |
| Get the DataStructure Type as defined in CommandTypes.h. | |
| virtual ActiveMQQueue * | 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) |
| 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 |
| virtual const cms::Queue * | 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) |
| 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 |
| virtual std::string | getQueueName () const |
| Gets the name of this queue. | |
Static Public Attributes | |
| static const unsigned char | ID_ACTIVEMQQUEUE = 100 |
Constructor & Destructor Documentation
| activemq::commands::ActiveMQQueue::ActiveMQQueue | ( | ) |
| activemq::commands::ActiveMQQueue::ActiveMQQueue | ( | const std::string & | name | ) |
| virtual activemq::commands::ActiveMQQueue::~ActiveMQQueue | ( | ) | throw () [virtual] |
Member Function Documentation
| virtual cms::Destination* activemq::commands::ActiveMQQueue::clone | ( | ) | const [inline, 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
Implements cms::Destination.
| virtual ActiveMQQueue* activemq::commands::ActiveMQQueue::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::ActiveMQDestination.
| virtual void activemq::commands::ActiveMQQueue::copy | ( | const cms::Destination & | source | ) | [inline, virtual] |
| virtual void activemq::commands::ActiveMQQueue::copyDataStructure | ( | const DataStructure * | src | ) | [virtual] |
Reimplemented from activemq::commands::ActiveMQDestination.
| virtual bool activemq::commands::ActiveMQQueue::equals | ( | const cms::Destination & | other | ) | const [virtual] |
| virtual bool activemq::commands::ActiveMQQueue::equals | ( | const DataStructure * | value | ) | const [virtual] |
Reimplemented from activemq::commands::ActiveMQDestination.
| virtual const cms::Queue* activemq::commands::ActiveMQQueue::getCMSDestination | ( | ) | const [inline, virtual] |
- 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::ActiveMQQueue::getCMSProperties | ( | ) | const [inline, 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.
Implements cms::Destination.
| virtual unsigned char activemq::commands::ActiveMQQueue::getDataStructureType | ( | ) | const [virtual] |
Get the DataStructure Type as defined in CommandTypes.h.
- Returns:
- The type of the data structure
Reimplemented from activemq::commands::ActiveMQDestination.
| virtual cms::Destination::DestinationType activemq::commands::ActiveMQQueue::getDestinationType | ( | ) | const [inline, virtual] |
Returns the Type of Destination that this object represents.
- Returns:
- int type qualifier.
Implements activemq::commands::ActiveMQDestination.
References cms::Destination::QUEUE.
| virtual std::string activemq::commands::ActiveMQQueue::getQueueName | ( | ) | const [inline, virtual] |
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::ActiveMQQueue::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::ActiveMQDestination.
Field Documentation
const unsigned char activemq::commands::ActiveMQQueue::ID_ACTIVEMQQUEUE = 100 [static] |
The documentation for this class was generated from the following file:
- src/main/activemq/commands/ActiveMQQueue.h
