activemq-cpp-3.9.0
activemq::core::ActiveMQDestinationSource Class Reference

#include <src/main/activemq/core/ActiveMQDestinationSource.h>

Inheritance diagram for activemq::core::ActiveMQDestinationSource:

Public Member Functions

 ActiveMQDestinationSource (ActiveMQConnection *connection)
 
virtual ~ActiveMQDestinationSource ()
 
virtual void start ()
 Starts the service. More...
 
virtual void stop ()
 Stops this service. More...
 
virtual void setListener (cms::DestinationListener *listener)
 Sets the current listener of Destination events. More...
 
virtual cms::DestinationListenergetListener () const
 Gets the currently configured DestiantionListener for this event source. More...
 
virtual std::vector< cms::Queue * > getQueues () const
 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. More...
 
virtual std::vector< cms::Topic * > getTopics () const
 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. More...
 
virtual std::vector
< cms::TemporaryQueue * > 
getTemporaryQueues () const
 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. More...
 
virtual std::vector
< cms::TemporaryTopic * > 
getTemporaryTopics () const
 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. More...
 
- Public Member Functions inherited from cms::DestinationSource
virtual ~DestinationSource ()
 
- Public Member Functions inherited from cms::Startable
virtual ~Startable ()
 
- Public Member Functions inherited from cms::Stoppable
virtual ~Stoppable ()
 

Constructor & Destructor Documentation

activemq::core::ActiveMQDestinationSource::ActiveMQDestinationSource ( ActiveMQConnection connection)
virtual activemq::core::ActiveMQDestinationSource::~ActiveMQDestinationSource ( )
virtual

Member Function Documentation

virtual cms::DestinationListener* activemq::core::ActiveMQDestinationSource::getListener ( ) const
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.

Implements cms::DestinationSource.

virtual std::vector<cms::Queue*> activemq::core::ActiveMQDestinationSource::getQueues ( ) const
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.

Implements cms::DestinationSource.

virtual std::vector<cms::TemporaryQueue*> activemq::core::ActiveMQDestinationSource::getTemporaryQueues ( ) const
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.

Implements cms::DestinationSource.

virtual std::vector<cms::TemporaryTopic*> activemq::core::ActiveMQDestinationSource::getTemporaryTopics ( ) const
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.

Implements cms::DestinationSource.

virtual std::vector<cms::Topic*> activemq::core::ActiveMQDestinationSource::getTopics ( ) const
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.

Implements cms::DestinationSource.

virtual void activemq::core::ActiveMQDestinationSource::setListener ( cms::DestinationListener listener)
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
listenerThe new listener to provide destination events to.

Implements cms::DestinationSource.

virtual void activemq::core::ActiveMQDestinationSource::start ( )
virtual

Starts the service.

Exceptions
CMSExceptionif an internal error occurs while starting.

Implements cms::Startable.

virtual void activemq::core::ActiveMQDestinationSource::stop ( )
virtual

Stops this service.

Exceptions
CMSException- if an internal error occurs while stopping the Service.

Implements cms::Stoppable.


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