SourcePro® 2024.1 |
SourcePro® API Reference Guide |
First-in-first-out (FIFO) queue that provides producer-consumer synchronization semantics for exchanging guarded values between cooperating threads. More...
#include <rw/itc/RWTPCValQueueGuarded.h>
Public Member Functions | |
RWTPCValQueueGuarded (size_t maxCapacity) | |
RWTPCValQueueGuarded (size_t maxCapacity, bool isOpen) | |
RWTPCValQueueGuarded (void) | |
~RWTPCValQueueGuarded (void) | |
Public Member Functions inherited from RWTPCValBufferBaseGuarded< Type, RWTGuardDecorator< Type > > | |
virtual | ~RWTPCValBufferBaseGuarded (void) |
RWWaitStatus | peek (Type &result, unsigned long milliseconds) |
Type | peek (void) |
RWWaitStatus | read (Type &result, unsigned long milliseconds) |
Type | read (void) |
bool | tryPeek (Type &value) |
bool | tryRead (Type &value) |
bool | tryWrite (const Type &value, const RWTFunctor< bool()> &guard) |
void | write (const Type &value, const RWTFunctor< bool()> &guard) |
RWWaitStatus | write (const Type &value, const RWTFunctor< bool()> &guard, unsigned long milliseconds) |
Public Member Functions inherited from RWTPCValBufferBaseDecorated< Type, RWTGuardDecorator< Type > > | |
virtual | ~RWTPCValBufferBaseDecorated (void) |
RWWaitStatus | peek (Type &result, unsigned long milliseconds) |
Type | peek (void) |
RWWaitStatus | read (Type &result, unsigned long milliseconds) |
Type | read (void) |
bool | tryPeek (Type &result) |
bool | tryRead (Type &result) |
bool | tryWrite (const Type &value) |
void | write (const Type &value) |
RWWaitStatus | write (const Type &value, unsigned long milliseconds) |
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 RWTPCValBufferBase< RWTGuardDecorator< Type > > | |
virtual | ~RWTPCValBufferBase (void) |
RWWaitStatus | peek (Type &result, unsigned long milliseconds) |
Type | peek (void) |
RWWaitStatus | read (Type &result, unsigned long milliseconds) |
Type | read (void) |
bool | tryPeek (Type &result) |
bool | tryRead (Type &result) |
bool | tryWrite (const Type &value) |
void | write (const Type &value) |
RWWaitStatus | write (const Type &value, unsigned long milliseconds) |
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) |
Protected Member Functions inherited from RWTMonitor< RWMutexLock > | |
RWTMonitor (const RWTMonitor< RWMutexLock > &second) | |
RWTMonitor (RWStaticCtor) | |
RWTMonitor (void) | |
~RWTMonitor (void) | |
void | acquire (void) |
bool | isAcquired (void) const |
RWTMonitor< RWMutexLock > & | monitor (void) const |
RWMutexLock & | mutex (void) |
RWTMonitor< RWMutexLock > & | operator= (const RWTMonitor< RWMutexLock > &) |
void | release (void) |
bool | tryAcquire (void) |
RWTPCValQueueGuarded is a first-in-first-out (FIFO) queue that provides producer-consumer synchronization semantics for exchanging guarded 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. The queue 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 to each value prior to storing that value in an internal buffer. A guard functor is used during read operations to determine whether the associated value is currently eligible for retrieval from the buffer.
OUTPUT:
|
inline |
Constructs a value-based, guarded, producer-consumer queue instance.
The queue is open on construction and enforces no limit on the number of items in the queue.
|
inline |
Constructs a value-based, guarded, producer-consumer queue instance.
The parameter maxCapacity specifies the maximum number of unread entries to allow 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 is used to indicate that the queue has no size limit other than that imposed by memory limitations, and that all write() operations should complete without blocking.
The queue is open on construction.
|
inline |
Constructs a value-based, guarded, producer-consumer queue instance.
The parameter maxCapacity specifies the maximum number of unread entries to allow 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 is used to indicate that the queue has no size limit other than that 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
, or the closed state, false
.
|
inline |
Destructor.
Copyright © 2024 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved. |