cms::DestinationSource Class Reference
Provides an object that will provide a snapshot view of Destinations that exist on the Message provider. More...
#include <src/main/cms/DestinationSource.h>
Public Member Functions | |
| virtual | ~DestinationSource () |
| virtual void | setListener (cms::DestinationListener *listener)=0 |
| Sets the current listener of Destination events. | |
| virtual cms::DestinationListener * | getListener () const =0 |
| Gets the currently configured DestiantionListener for this event source. | |
| virtual std::vector< cms::Queue * > | getQueues () const =0 |
| Returns a snapshot of the currently known Queues that are active on the CMS provider, this state can change at any time as Destinations are added and deleted from the provider. | |
| virtual std::vector< cms::Topic * > | getTopics () const =0 |
| Returns a snapshot of the currently known Queues that are active on the CMS provider, this state can change at any time as Destinations are added and deleted from the provider. | |
| virtual std::vector < cms::TemporaryQueue * > | getTemporaryQueues () const =0 |
| Returns a snapshot of the currently known Queues that are active on the CMS provider, this state can change at any time as Destinations are added and deleted from the provider. | |
| virtual std::vector < cms::TemporaryTopic * > | getTemporaryTopics () const =0 |
| Returns a snapshot of the currently known Queues that are active on the CMS provider, this state can change at any time as Destinations are added and deleted from the provider. | |
Detailed Description
Provides an object that will provide a snapshot view of Destinations that exist on the Message provider.
- Since:
- 3.2
Constructor & Destructor Documentation
| virtual cms::DestinationSource::~DestinationSource | ( | ) | [virtual] |
Member Function Documentation
| virtual cms::DestinationListener* cms::DestinationSource::getListener | ( | ) | const [pure virtual] |
Gets the currently configured DestiantionListener for this event source.
The event source instance remains active in this DestinationSource until it is removed via a call to setListener(null) and should not be deleted until the client is sure it will not receive any future events.
- Returns:
- the configured DestinationListener for this event source or null if none.
Implemented in activemq::core::ActiveMQDestinationSource.
| virtual std::vector<cms::Queue*> cms::DestinationSource::getQueues | ( | ) | const [pure virtual] |
Returns a snapshot of the currently known Queues that are active on the CMS provider, this state can change at any time as Destinations are added and deleted from the provider.
The destinations are cloned and placed into the returned vector, the caller is responsible for deleting these cloned objects.
- Returns:
- an STL vector containing the current list of known Queues.
Implemented in activemq::core::ActiveMQDestinationSource.
| virtual std::vector<cms::TemporaryQueue*> cms::DestinationSource::getTemporaryQueues | ( | ) | const [pure virtual] |
Returns a snapshot of the currently known Queues that are active on the CMS provider, this state can change at any time as Destinations are added and deleted from the provider.
The destinations are cloned and placed into the returned vector, the caller is responsible for deleting these cloned objects.
- Returns:
- an STL vector containing the current list of known Queues.
Implemented in activemq::core::ActiveMQDestinationSource.
| virtual std::vector<cms::TemporaryTopic*> cms::DestinationSource::getTemporaryTopics | ( | ) | const [pure virtual] |
Returns a snapshot of the currently known Queues that are active on the CMS provider, this state can change at any time as Destinations are added and deleted from the provider.
The destinations are cloned and placed into the returned vector, the caller is responsible for deleting these cloned objects.
- Returns:
- an STL vector containing the current list of known Queues.
Implemented in activemq::core::ActiveMQDestinationSource.
| virtual std::vector<cms::Topic*> cms::DestinationSource::getTopics | ( | ) | const [pure virtual] |
Returns a snapshot of the currently known Queues that are active on the CMS provider, this state can change at any time as Destinations are added and deleted from the provider.
The destinations are cloned and placed into the returned vector, the caller is responsible for deleting these cloned objects.
- Returns:
- an STL vector containing the current list of known Queues.
Implemented in activemq::core::ActiveMQDestinationSource.
| virtual void cms::DestinationSource::setListener | ( | cms::DestinationListener * | listener | ) | [pure virtual] |
Sets the current listener of Destination events.
This class does not manage the lifetime of the configured listener, the client must ensure that it deletes the listener instance at the appropriate time.
- Parameters:
-
listener The new listener to provide destination events to.
Implemented in activemq::core::ActiveMQDestinationSource.
The documentation for this class was generated from the following file:
- src/main/cms/DestinationSource.h
