CS::SndSys::Queue< T > Class Template Reference
#include <csplugincommon/sndsys/queue.h>
Public Member Functions | |
void | Clear () |
T * | DequeueEntry (bool bWait=false) |
bool | Find (T *data) |
Compares pointers, and not the objects they point to. | |
bool | GetClosed () |
bool | GetDupecheck () |
Retrieve the status of duplicate pointer checking. | |
QueueIterator< T > * | GetIterator () |
size_t | Length () |
Retrieve the number of entries in the queue. | |
Queue () | |
Queue construction requires no parameters. | |
QueueErrorType | QueueEntry (T *pData) |
Add the specified pointer to the end of the queue. | |
void | SetClosed (bool Closed) |
Close the queue so that no further entries may be added. | |
void | SetDupecheck (bool Check) |
Turn on/off duplicate entry pointer checking. | |
~Queue () | |
Protected Attributes | |
volatile bool | m_bClosed |
Flag indicating whether new entries may be added to this queue. | |
volatile bool | m_bDupeCheck |
size_t | m_EntryCount |
Number of entries currently in the queue. | |
CS::Threading::RecursiveMutex | m_pAccessMutex |
The mutex which restricts access to all queue operations. | |
CS::Threading::Condition | m_pEntryReadyCondition |
The condition used for waiting on and signaling availability of entries. | |
QEntry< T > * | m_pHead |
Pointer to the oldest entry in the queue. | |
QEntry< T > * | m_pTail |
Pointer to the newest entry in the queue. | |
Friends | |
class | QueueIterator< T > |
Detailed Description
template<typename T>
class CS::SndSys::Queue< T >
A threadsafe, pointer-passing queue (First-In First-Out) implementation for the sound system.
- Warning:
- csRef<> is not threadsafe, and csPtr<> doesn't let us do anything with the object referenced inside so this class, which is specifically designed to communicate between threads, has no choice but to use raw pointers. If this is used to communicate between threads, the 'feeder' thread should incref the object before passing it into the queue. The 'consumer' thread should NOT touch the refcount unless it's certain that no other thread will be touching the refcount. This makes cleanup ... interesting. One possible method for cleanup is for the 'consumer' thread which implicitly holds a single reference (passed from the 'feeder') to wait for the refcount to reach 1 before releasing it's refcount, since a refcount of 1 means that it should have the only reference and thus should be guaranteed to be the only thread working with the refcount. Another possibility is for the 'consumer' thread to queue this object back to the 'feeder' thread (through another queue), which will perform the decref itself.
If an object passed through this queue is meant to be accessed from multiple threads at once, the object must contain threadsafe methods itself.
Definition at line 96 of file queue.h.
Constructor & Destructor Documentation
CS::SndSys::Queue< T >::Queue | ( | ) | [inline] |
Member Function Documentation
void CS::SndSys::Queue< T >::Clear | ( | ) | [inline] |
Clear all entries in the queue.
- Warning:
- This call will NOT delete the underlying object, or release any reference counts. To clear the queue in a more controlled manner, consider calling Close(true), then fetching each queue entry and handling them as appropriate for your use.
Definition at line 118 of file queue.h.
Referenced by CS::SndSys::Queue< CS::SndSys::SndSysBasicStream::StreamNotificationEvent >::~Queue().
T* CS::SndSys::Queue< T >::DequeueEntry | ( | bool | bWait = false |
) | [inline] |
Dequeue an entry from the queue This call can optionally wait for an entry to arrive if the bWait parameter is specified as true.
bool CS::SndSys::Queue< T >::Find | ( | T * | data | ) | [inline] |
Compares pointers, and not the objects they point to.
Definition at line 214 of file queue.h.
Referenced by CS::SndSys::Queue< CS::SndSys::SndSysBasicStream::StreamNotificationEvent >::QueueEntry().
bool CS::SndSys::Queue< T >::GetClosed | ( | ) | [inline] |
bool CS::SndSys::Queue< T >::GetDupecheck | ( | ) | [inline] |
QueueIterator<T>* CS::SndSys::Queue< T >::GetIterator | ( | ) | [inline] |
size_t CS::SndSys::Queue< T >::Length | ( | ) | [inline] |
QueueErrorType CS::SndSys::Queue< T >::QueueEntry | ( | T * | pData | ) | [inline] |
void CS::SndSys::Queue< T >::SetClosed | ( | bool | Closed | ) | [inline] |
void CS::SndSys::Queue< T >::SetDupecheck | ( | bool | Check | ) | [inline] |
Member Data Documentation
volatile bool CS::SndSys::Queue< T >::m_bClosed [protected] |
Flag indicating whether new entries may be added to this queue.
Definition at line 285 of file queue.h.
Referenced by CS::SndSys::Queue< CS::SndSys::SndSysBasicStream::StreamNotificationEvent >::GetClosed(), CS::SndSys::Queue< CS::SndSys::SndSysBasicStream::StreamNotificationEvent >::GetDupecheck(), CS::SndSys::Queue< CS::SndSys::SndSysBasicStream::StreamNotificationEvent >::QueueEntry(), and CS::SndSys::Queue< CS::SndSys::SndSysBasicStream::StreamNotificationEvent >::SetClosed().
volatile bool CS::SndSys::Queue< T >::m_bDupeCheck [protected] |
Flag indicating whether the same pointer may exist multiple times in this queue.
Definition at line 288 of file queue.h.
Referenced by CS::SndSys::Queue< CS::SndSys::SndSysBasicStream::StreamNotificationEvent >::QueueEntry(), and CS::SndSys::Queue< CS::SndSys::SndSysBasicStream::StreamNotificationEvent >::SetDupecheck().
size_t CS::SndSys::Queue< T >::m_EntryCount [protected] |
Number of entries currently in the queue.
Definition at line 283 of file queue.h.
Referenced by CS::SndSys::Queue< CS::SndSys::SndSysBasicStream::StreamNotificationEvent >::Length().
CS::Threading::RecursiveMutex CS::SndSys::Queue< T >::m_pAccessMutex [protected] |
The mutex which restricts access to all queue operations.
Definition at line 294 of file queue.h.
Referenced by CS::SndSys::Queue< CS::SndSys::SndSysBasicStream::StreamNotificationEvent >::Clear(), CS::SndSys::Queue< CS::SndSys::SndSysBasicStream::StreamNotificationEvent >::DequeueEntry(), CS::SndSys::Queue< CS::SndSys::SndSysBasicStream::StreamNotificationEvent >::Find(), CS::SndSys::Queue< CS::SndSys::SndSysBasicStream::StreamNotificationEvent >::GetClosed(), CS::SndSys::Queue< CS::SndSys::SndSysBasicStream::StreamNotificationEvent >::GetDupecheck(), CS::SndSys::Queue< CS::SndSys::SndSysBasicStream::StreamNotificationEvent >::QueueEntry(), CS::SndSys::Queue< CS::SndSys::SndSysBasicStream::StreamNotificationEvent >::SetClosed(), and CS::SndSys::Queue< CS::SndSys::SndSysBasicStream::StreamNotificationEvent >::SetDupecheck().
CS::Threading::Condition CS::SndSys::Queue< T >::m_pEntryReadyCondition [protected] |
The condition used for waiting on and signaling availability of entries.
Definition at line 296 of file queue.h.
Referenced by CS::SndSys::Queue< CS::SndSys::SndSysBasicStream::StreamNotificationEvent >::Clear(), CS::SndSys::Queue< CS::SndSys::SndSysBasicStream::StreamNotificationEvent >::DequeueEntry(), and CS::SndSys::Queue< CS::SndSys::SndSysBasicStream::StreamNotificationEvent >::QueueEntry().
QEntry<T>* CS::SndSys::Queue< T >::m_pHead [protected] |
Pointer to the oldest entry in the queue.
Definition at line 279 of file queue.h.
Referenced by CS::SndSys::Queue< CS::SndSys::SndSysBasicStream::StreamNotificationEvent >::Clear(), CS::SndSys::Queue< CS::SndSys::SndSysBasicStream::StreamNotificationEvent >::DequeueEntry(), CS::SndSys::Queue< CS::SndSys::SndSysBasicStream::StreamNotificationEvent >::Find(), and CS::SndSys::Queue< CS::SndSys::SndSysBasicStream::StreamNotificationEvent >::QueueEntry().
QEntry<T>* CS::SndSys::Queue< T >::m_pTail [protected] |
Pointer to the newest entry in the queue.
Definition at line 281 of file queue.h.
Referenced by CS::SndSys::Queue< CS::SndSys::SndSysBasicStream::StreamNotificationEvent >::Clear(), CS::SndSys::Queue< CS::SndSys::SndSysBasicStream::StreamNotificationEvent >::DequeueEntry(), and CS::SndSys::Queue< CS::SndSys::SndSysBasicStream::StreamNotificationEvent >::QueueEntry().
The documentation for this class was generated from the following file:
- csplugincommon/sndsys/queue.h
Generated for Crystal Space 1.2.1 by doxygen 1.5.3