RWTPCValStackGuardedPrioritized< Type > Class Template Reference
[Interthread Communication]

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

#include <rw/itc/RWTPCValStackGuardedPrioritized.h>

Inheritance diagram for RWTPCValStackGuardedPrioritized< Type >:

List of all members.

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

---

Detailed Description

template<class Type>
class RWTPCValStackGuardedPrioritized< Type >

RWTPCValStackGuardedPrioritized<Type> is a last-in-first-out (LIFO) stack that provides producer-consumer synchronization semantics for exchanging guarded and prioritized 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. The stack is considered full when the number of unread entries equals or exceeds some user-specified maximum capacity.

The write operations inherited by this class bind a guard functor and priority value to each data value prior to storing that value in an internal buffer. The guard functor is used during read operations to determine whether the associated value is currently eligible for retrieval from the buffer. The priority value is used during write operations to determine a value's insertion point within the stack, such that the set of unread values will be retrieved in priority order when they are eventually read from the stack. A new value is retrieved before any previously inserted values of the same priority, except when the retrieval of the newer values is prohibited by their guard functors.

Examples

See the example given under RWTPCValQueueGuardedPrioritized<Type> .

---

Constructor & Destructor Documentation

template<class Type >

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

Constructs a value-based, guarded, prioritized, 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, indicates 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 >

RWTPCValStackGuardedPrioritized< Type >::~RWTPCValStackGuardedPrioritized

(

void

)

[inline]

Destructor.