qpid::sys::ProducerConsumer::ConsumerLock Struct Reference

Lock for code that consumes items. More...

#include <ProducerConsumer.h>

Inheritance diagram for qpid::sys::ProducerConsumer::ConsumerLock:

[legend]Collaboration diagram for qpid::sys::ProducerConsumer::ConsumerLock:

[legend]List of all members.

Public Member Functions
	ConsumerLock (ProducerConsumer &p)
	Wait for an item to consume and acquire locks.
	ConsumerLock (ProducerConsumer &p, const Time &timeout)
	Wait up to timeout to acquire lock.
	~ConsumerLock ()
	Release locks.

---

Detailed Description

Lock for code that consumes items.

---

Constructor & Destructor Documentation

qpid::sys::ProducerConsumer::ConsumerLock::ConsumerLock

(

ProducerConsumer &

p

)

Wait for an item to consume and acquire locks.

Postcondition:

If isOk() there is at least one item available and the calling thread has exclusive access to consume it.

qpid::sys::ProducerConsumer::ConsumerLock::ConsumerLock	(	ProducerConsumer &	p,
		const Time &	timeout
	)

Wait up to timeout to acquire lock.

Postcondition:

If isOk() caller has a producer lock. If isTimedOut() there was a timeout. If neither then we were shutdown.

---

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

• /home/aconway/svn/qpid/cpp/src/qpid/sys/ProducerConsumer.h

---