#include <XnThreadSafeQueue.h>
Inheritance diagram for XnThreadSafeQueue:
Public Member Functions | |
| XnStatus | Init () |
| XnStatus | Pop (XnValue &value) |
| XnStatus | Push (XnValue const &value) |
| XnUInt32 | Size () const |
| XnThreadSafeQueue () | |
| ~XnThreadSafeQueue () | |
Private Attributes | |
| XN_CRITICAL_SECTION_HANDLE | m_hLock |
Detailed Description
A thread safe queue.
Definition at line 40 of file XnThreadSafeQueue.h.
Constructor & Destructor Documentation
| XnThreadSafeQueue::XnThreadSafeQueue | ( | ) | [inline] |
Definition at line 43 of file XnThreadSafeQueue.h.
| XnThreadSafeQueue::~XnThreadSafeQueue | ( | ) | [inline] |
Definition at line 45 of file XnThreadSafeQueue.h.
Member Function Documentation
| XnStatus XnThreadSafeQueue::Init | ( | ) | [inline, virtual] |
Initialized the queue. This method should be called before calling any other method.
Reimplemented from XnQueue.
Definition at line 50 of file XnThreadSafeQueue.h.
| XnStatus XnThreadSafeQueue::Pop | ( | XnValue & | value | ) | [inline, virtual] |
Pop the value at the top of the queue
- Parameters:
-
value [out] The value that was at the top of the queue
- Returns:
- XN_STATUS_IS_EMPTY The queue is empty
Reimplemented from XnQueue.
Definition at line 73 of file XnThreadSafeQueue.h.
| XnStatus XnThreadSafeQueue::Push | ( | XnValue const & | value | ) | [inline, virtual] |
Push a new value to the queue
- Parameters:
-
value [in] The value to add to the queue
- Returns:
- XN_STATUS_ALLOC_FAILED Failed to add to the queue because no nodes are available.
Reimplemented from XnQueue.
Definition at line 60 of file XnThreadSafeQueue.h.
| XnUInt32 XnThreadSafeQueue::Size | ( | ) | const [inline, virtual] |
Get current size of queue
Reimplemented from XnQueue.
Definition at line 86 of file XnThreadSafeQueue.h.
Member Data Documentation
XN_CRITICAL_SECTION_HANDLE XnThreadSafeQueue::m_hLock [mutable, private] |
Definition at line 96 of file XnThreadSafeQueue.h.
The documentation for this class was generated from the following file: