RWTPCPtrStack< Type > Class Template Reference
[Interthread Communication]

Last-in-first-out (LIFO) stack that provides producer-consumer synchronization semantics for exchanging pointer values between cooperating threads. More...

#include <rw/itc/RWTPCPtrStack.h>

Inheritance diagram for RWTPCPtrStack< Type >:

List of all members.

Public Member Functions
	RWTPCPtrStack (size_t maxCapacity=0, bool isOpen=true)
	~RWTPCPtrStack (void)

---

Detailed Description

template<class Type>
class RWTPCPtrStack< Type >

RWTPCPtrStack<Type> is a last-in-first-out (LIFO) stack that provides producer-consumer synchronization semantics for exchanging pointer values between cooperating threads.

In the producer-consumer synchronization model, reader threads (consumers) are blocked while the stack is empty, and writer threads (producers) are blocked while the stack is full. A buffer is considered full when the number of unread entries equals or exceeds some user-specified maximum capacity.

Examples

See RWTPCValQueue<Type> for a producer-consumer example.

---

Constructor & Destructor Documentation

template<class Type >

RWTPCPtrStack< Type >::RWTPCPtrStack	(	size_t	maxCapacity = 0,
		bool	isOpen = true
	)			[inline]

Constructs a pointer-based producer-consumer stack instance.

The parameter maxCapacity specifies the maximum number of unread entries allowed to accumulate within the stack. Once the number of entries in the stack equals this number, any thread attempting to write an additional entry is blocked until an entry is removed by a read() operation, or until the capacity is increased. A capacity of zero, the default, is used to indicate that the stack has no size limit, except as imposed by memory limitations, and that all write() operations should complete without blocking.

The parameter isOpen is a bool value that specifies whether the stack should be initialized in the open state (true, the default) or the closed state (false).

template<class Type >

RWTPCPtrStack< Type >::~RWTPCPtrStack

(

void

)

[inline]

Destructor.