cms::Queue Class Reference
An interface encapsulating a provider-specific queue name. More...
#include <src/main/cms/Queue.h>
Inheritance diagram for cms::Queue:
Public Member Functions | |
| virtual | ~Queue () |
| virtual std::string | getQueueName () const =0 |
| Gets the name of this queue. | |
 Public Member Functions inherited from cms::Destination | |
| 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. | |
Additional Inherited Members | |
| Public Types inherited from cms::Destination | |
| enum | DestinationType { TOPIC, QUEUE, TEMPORARY_TOPIC, TEMPORARY_QUEUE } |
Detailed Description
An interface encapsulating a provider-specific queue name.
Messages sent to a Queue are sent to a Single Subscriber on that Queue Destination. This allows for Queues to be used as load balances implementing a SEDA based architecture. The length of time that a Provider will store a Message in a Queue is not defined by the CMS API, consult your Provider documentation for this information.
- Since
- 1.0
Constructor & Destructor Documentation
|
virtual |
Member Function Documentation
|
pure virtual |
Gets the name of this queue.
- Returns
- The queue name.
- Exceptions
-
CMSException - If an internal error occurs.
Implemented in activemq::commands::ActiveMQQueue, and activemq::commands::ActiveMQTempQueue.
The documentation for this class was generated from the following file:
- src/main/cms/Queue.h
