SourcePro® API Reference Guide

 
List of all members | Public Member Functions
RWTPCPtrStack< Type > Class Template Reference

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 >:
RWTPCPtrBufferBase< Type > RWPCBufferBase RWTMonitor< RWMutexLock >

Public Member Functions

 RWTPCPtrStack (void)
 
 RWTPCPtrStack (size_t maxCapacity)
 
 RWTPCPtrStack (size_t maxCapacity, bool isOpen)
 
 ~RWTPCPtrStack (void)
 
- Public Member Functions inherited from RWTPCPtrBufferBase< Type >
virtual ~RWTPCPtrBufferBase (void)
 
Type * peek (void)
 
RWWaitStatus peek (Type *&value, unsigned long milliseconds)
 
Type * read (void)
 
RWWaitStatus read (Type *&value, unsigned long milliseconds)
 
bool tryPeek (Type *&result)
 
bool tryRead (Type *&result)
 
bool tryWrite (Type *value)
 
void write (Type *value)
 
RWWaitStatus write (Type *value, unsigned long milliseconds)
 
- Public Member Functions inherited from RWPCBufferBase
virtual ~RWPCBufferBase (void)
 
bool canRead (void) const
 
bool canWrite (void) const
 
void close (void)
 
size_t entries (void) const
 
void flush (void)
 
size_t getCapacity (void) const
 
RWTFunctor< void()> getCloseCallback (void) const
 
RWTFunctor< void()> getEmptyCallback (void) const
 
RWTFunctor< void()> getFullCallback (void) const
 
RWTFunctor< void()> getOpenCallback (void) const
 
bool isOpen (void) const
 
void open (void)
 
size_t setCapacity (size_t maxCapacity)
 
void setCloseCallback (const RWTFunctor< void()> &onCloseCallback)
 
void setEmptyCallback (const RWTFunctor< void()> &onEmptyCallback)
 
void setFullCallback (const RWTFunctor< void()> &onFullCallback)
 
void setOpenCallback (const RWTFunctor< void()> &onOpenCallback)
 

Additional Inherited Members

- Protected Types inherited from RWTMonitor< RWMutexLock >
typedef RWTLockGuard< RWTMonitor< RWMutexLock > > LockGuard
 
typedef RWTTryLockGuard< RWTMonitor< RWMutexLock > > TryLockGuard
 
typedef RWTUnlockGuard< RWTMonitor< RWMutexLock > > UnlockGuard
 
- Protected Member Functions inherited from RWTMonitor< RWMutexLock >
 RWTMonitor ()
 
 RWTMonitor (RWStaticCtor)
 
 RWTMonitor (const RWTMonitor< RWMutexLock > &second)
 
 ~RWTMonitor ()
 
void acquire ()
 
bool isAcquired () const
 
RWTMonitor< RWMutexLock > & monitor () const
 
RWMutexLockmutex ()
 
RWTMonitor< RWMutexLock > & operator= (const RWTMonitor< RWMutexLock > &)
 
void release ()
 
bool tryAcquire ()
 

Detailed Description

template<class Type>
class RWTPCPtrStack< Type >

RWTPCPtrStack 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.

Example
See RWTPCValQueue for a producer-consumer example.

Constructor & Destructor Documentation

template<class Type >
RWTPCPtrStack< Type >::RWTPCPtrStack ( void  )
inline

Constructs a pointer-based producer-consumer stack instance.

The stack is open on construction and enforces no limit on the number of items in the stack.

template<class Type >
RWTPCPtrStack< Type >::RWTPCPtrStack ( size_t  maxCapacity)
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 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 stack is open on construction.

template<class Type >
RWTPCPtrStack< Type >::RWTPCPtrStack ( size_t  maxCapacity,
bool  isOpen 
)
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 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) or the closed state (false).

template<class Type >
RWTPCPtrStack< Type >::~RWTPCPtrStack ( void  )
inline

Destructor.

Copyright © 2023 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved.