activemq::concurrent::Synchronizable Class Reference

#include <Synchronizable.h>

Inheritance diagram for activemq::concurrent::Synchronizable:

List of all members.

Public Member Functions
virtual	~Synchronizable ()
virtual void	lock ()=0 throw (exceptions::ActiveMQException)
virtual void	unlock ()=0 throw (exceptions::ActiveMQException)
virtual void	wait ()=0 throw (exceptions::ActiveMQException)
virtual void	wait (unsigned long millisecs)=0 throw (exceptions::ActiveMQException)
virtual void	notify ()=0 throw ( exceptions::ActiveMQException )
virtual void	notifyAll ()=0 throw ( exceptions::ActiveMQException )

---

Detailed Description

The interface for all synchronizable objects (that is, objects that can be locked and unlocked).

---

Constructor & Destructor Documentation

virtual activemq::concurrent::Synchronizable::~Synchronizable (   )  [inline, virtual]

---

Member Function Documentation

virtual void activemq::concurrent::Synchronizable::lock (   )  throw (exceptions::ActiveMQException) [pure virtual]

Locks the object. Exceptions: ActiveMQException  Implemented in activemq::concurrent::Mutex, activemq::io::BufferedInputStream, activemq::io::BufferedOutputStream, activemq::io::ByteArrayInputStream, activemq::io::ByteArrayOutputStream, activemq::network::SocketInputStream, activemq::network::SocketOutputStream, activemq::transport::FutureResponse, activemq::util::Queue< T >, activemq::util::Queue< Task >, and activemq::util::Queue< cms::Message * >.

virtual void activemq::concurrent::Synchronizable::notify (   )  throw ( exceptions::ActiveMQException ) [pure virtual]

Signals a waiter on this object that it can now wake up and continue. Must have this object locked before calling. Exceptions: ActiveMQException  Implemented in activemq::concurrent::Mutex, activemq::io::BufferedInputStream, activemq::io::BufferedOutputStream, activemq::io::ByteArrayInputStream, activemq::io::ByteArrayOutputStream, activemq::network::SocketInputStream, activemq::network::SocketOutputStream, activemq::transport::FutureResponse, activemq::util::Queue< T >, activemq::util::Queue< Task >, and activemq::util::Queue< cms::Message * >.

virtual void activemq::concurrent::Synchronizable::notifyAll (   )  throw ( exceptions::ActiveMQException ) [pure virtual]

Signals the waiters on this object that it can now wake up and continue. Must have this object locked before calling. Exceptions: ActiveMQException  Implemented in activemq::concurrent::Mutex, activemq::io::BufferedInputStream, activemq::io::BufferedOutputStream, activemq::io::ByteArrayInputStream, activemq::io::ByteArrayOutputStream, activemq::network::SocketInputStream, activemq::network::SocketOutputStream, activemq::transport::FutureResponse, activemq::util::Queue< T >, activemq::util::Queue< Task >, and activemq::util::Queue< cms::Message * >.

virtual void activemq::concurrent::Synchronizable::unlock (   )  throw (exceptions::ActiveMQException) [pure virtual]

Unlocks the object. Exceptions: ActiveMQException  Implemented in activemq::concurrent::Mutex, activemq::io::BufferedInputStream, activemq::io::BufferedOutputStream, activemq::io::ByteArrayInputStream, activemq::io::ByteArrayOutputStream, activemq::network::SocketInputStream, activemq::network::SocketOutputStream, activemq::transport::FutureResponse, activemq::util::Queue< T >, activemq::util::Queue< Task >, and activemq::util::Queue< cms::Message * >.

virtual void activemq::concurrent::Synchronizable::wait (  unsigned long  millisecs  )  throw (exceptions::ActiveMQException) [pure virtual]

Waits on a signal from this object, which is generated by a call to Notify. Must have this object locked before calling. This wait will timeout after the specified time interval. Parameters: millisecs  the time in millisecsonds to wait, or WAIT_INIFINITE Exceptions: ActiveMQException  Implemented in activemq::concurrent::Mutex, activemq::io::BufferedInputStream, activemq::io::BufferedOutputStream, activemq::io::ByteArrayInputStream, activemq::io::ByteArrayOutputStream, activemq::network::SocketInputStream, activemq::network::SocketOutputStream, activemq::transport::FutureResponse, activemq::util::Queue< T >, activemq::util::Queue< Task >, and activemq::util::Queue< cms::Message * >.

virtual void activemq::concurrent::Synchronizable::wait (   )  throw (exceptions::ActiveMQException) [pure virtual]

Waits on a signal from this object, which is generated by a call to Notify. Must have this object locked before calling. Exceptions: ActiveMQException  Implemented in activemq::concurrent::Mutex, activemq::io::BufferedInputStream, activemq::io::BufferedOutputStream, activemq::io::ByteArrayInputStream, activemq::io::ByteArrayOutputStream, activemq::network::SocketInputStream, activemq::network::SocketOutputStream, activemq::transport::FutureResponse, activemq::util::Queue< T >, activemq::util::Queue< Task >, and activemq::util::Queue< cms::Message * >.

---

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

• activemq-cpp/src/main/activemq/concurrent/Synchronizable.h

---