cms::Stoppable Class Reference

Interface for a class that implements the stop method. More...

#include <src/main/cms/Stoppable.h>

Inheritance diagram for cms::Stoppable:

Public Member Functions
virtual	~Stoppable ()
virtual void	stop ()=0
	Stops this service.

---

Detailed Description

Interface for a class that implements the stop method.

An object that implements this interface implies that it will halt all operations that result in events being propagated to external users, internally the Object can continue to process data but not events will be generated to clients and methods that return data will not return valid results until the object is started again.

Since:

1.0

---

Constructor & Destructor Documentation

virtual cms::Stoppable::~Stoppable

(

)

[virtual]

---

Member Function Documentation

virtual void cms::Stoppable::stop

(

)

[pure virtual]

Stops this service.

Exceptions:

CMSException

- if an internal error occurs while stopping the Service.

Implemented in activemq::cmsutil::CachedConsumer, activemq::cmsutil::PooledSession, activemq::core::ActiveMQConnection, activemq::core::ActiveMQConsumer, and activemq::core::ActiveMQSession.

Referenced by activemq::cmsutil::PooledSession::stop().

---

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

• src/main/cms/Stoppable.h