activemq::transport::FutureResponse Class Reference

#include <FutureResponse.h>

Inheritance diagram for activemq::transport::FutureResponse:

List of all members.

Public Member Functions
	FutureResponse ()
virtual	~FutureResponse ()
virtual void	lock () throw ( exceptions::ActiveMQException )
virtual void	unlock () throw ( exceptions::ActiveMQException )
virtual void	wait () throw ( exceptions::ActiveMQException )
virtual void	wait (unsigned long millisecs) throw ( exceptions::ActiveMQException )
virtual void	notify () throw ( exceptions::ActiveMQException )
virtual void	notifyAll () throw ( exceptions::ActiveMQException )
virtual const Response *	getResponse () const
virtual Response *	getResponse ()
virtual void	setResponse (Response *response)
Private Attributes
Response *	response
concurrent::Mutex	mutex

---

Detailed Description

A container that holds a response object. Since this object is Synchronizable, callers can wait on this object and when a response comes in, notify can be called to inform those waiting that the response is now available.

---

Constructor & Destructor Documentation

activemq::transport::FutureResponse::FutureResponse (   )  [inline]

virtual activemq::transport::FutureResponse::~FutureResponse (   )  [inline, virtual]

---

Member Function Documentation

virtual Response* activemq::transport::FutureResponse::getResponse (   )  [inline, virtual]

virtual const Response* activemq::transport::FutureResponse::getResponse (   )  const [inline, virtual]

Getters for the response property. Returns: the response object for the request

virtual void activemq::transport::FutureResponse::lock (   )  throw ( exceptions::ActiveMQException ) [inline, virtual]

Locks the object. Exceptions: ActiveMQException  Implements activemq::concurrent::Synchronizable.

virtual void activemq::transport::FutureResponse::notify (   )  throw ( exceptions::ActiveMQException ) [inline, virtual]

Signals a waiter on this object that it can now wake up and continue. Must have this object locked before calling. Exceptions: ActiveMQException  Implements activemq::concurrent::Synchronizable.

virtual void activemq::transport::FutureResponse::notifyAll (   )  throw ( exceptions::ActiveMQException ) [inline, virtual]

Signals the waiters on this object that it can now wake up and continue. Must have this object locked before calling. Exceptions: ActiveMQException  Implements activemq::concurrent::Synchronizable.

virtual void activemq::transport::FutureResponse::setResponse (  Response *  response  )  [inline, virtual]

Setter for the response property. Parameters: response  the response object for the request.

virtual void activemq::transport::FutureResponse::unlock (   )  throw ( exceptions::ActiveMQException ) [inline, virtual]

Unlocks the object. Exceptions: ActiveMQException  Implements activemq::concurrent::Synchronizable.

virtual void activemq::transport::FutureResponse::wait (  unsigned long  millisecs  )  throw ( exceptions::ActiveMQException ) [inline, 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  time in millisecsonds to wait, or WAIT_INIFINITE Exceptions: ActiveMQException  Implements activemq::concurrent::Synchronizable.

virtual void activemq::transport::FutureResponse::wait (   )  throw ( exceptions::ActiveMQException ) [inline, 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  Implements activemq::concurrent::Synchronizable.

---

Member Data Documentation

concurrent::Mutex activemq::transport::FutureResponse::mutex [private]

Response* activemq::transport::FutureResponse::response [private]

---

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

• activemq-cpp/src/main/activemq/transport/FutureResponse.h

---