rwlogo
SourcePro C++ 12.0

SourcePro® C++ API Reference Guide



   SourcePro C++
Documentation Home

RWTPCPtrQueue< Type > Class Template Reference
[Interthread Communication]

First-in-first-out (FIFO) queue with producer-consumer synchronization semantics for exchanging pointer values between cooperating threads. More...

#include <rw/itc/RWTPCPtrQueue.h>

Inheritance diagram for RWTPCPtrQueue< Type >:
RWTPCPtrBufferBase< Type > RWPCBufferBase RWTMonitor< RWMutexLock >

List of all members.

Public Member Functions

 RWTPCPtrQueue (size_t maxCapacity=0, bool isOpen=true)
 ~RWTPCPtrQueue (void)

Detailed Description

template<class Type>
class RWTPCPtrQueue< Type >

RWTPCPtrQueue<Type> is a first-in-first-out (FIFO) queue 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 queue is empty, and writer threads (producers) are blocked while the queue 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 queue example.


Constructor & Destructor Documentation

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

Constructs a pointer-based producer-consumer queue instance.

The parameter maxCapacity specifies the maximum number of unread entries allowed to accumulate within the queue. Once the number of entries in the queue 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 queue 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 queue should be initialized in the open state (true, the default) or the closed state (false).

template<class Type >
RWTPCPtrQueue< Type >::~RWTPCPtrQueue ( void   )  [inline]

Destructor.

 All Classes Functions Variables Typedefs Enumerations Enumerator Friends

© Copyright Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave and SourcePro are registered trademarks of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.