OpenNI 1.5.4: XnThreadSafeQueue Class Reference


XnThreadSafeQueue Class Reference

#include <XnThreadSafeQueue.h>

Inheritance diagram for XnThreadSafeQueue:

List of all members.

Public Member Functions

 XnThreadSafeQueue ()
 ~XnThreadSafeQueue ()
XnStatus Init ()
XnStatus Push (XnValue const &value)
XnStatus Pop (XnValue &value)
XnUInt32 Size () const

Detailed Description

A thread safe queue.

Constructor & Destructor Documentation

XnThreadSafeQueue::XnThreadSafeQueue ( ) [inline]
XnThreadSafeQueue::~XnThreadSafeQueue ( ) [inline]

Member Function Documentation

XnStatus XnThreadSafeQueue::Init ( ) [inline, virtual]

Initialized the queue. This method should be called before calling any other method.

Reimplemented from XnQueue.

XnStatus XnThreadSafeQueue::Pop ( XnValue value) [inline, virtual]

Pop the value at the top of the queue

value[out] The value that was at the top of the queue
XN_STATUS_IS_EMPTY The queue is empty

Reimplemented from XnQueue.

XnStatus XnThreadSafeQueue::Push ( XnValue const &  value) [inline, virtual]

Push a new value to the queue

value[in] The value to add to the queue
XN_STATUS_ALLOC_FAILED Failed to add to the queue because no nodes are available.

Reimplemented from XnQueue.

XnUInt32 XnThreadSafeQueue::Size ( ) const [inline, virtual]

Get current size of queue

Reimplemented from XnQueue.

The documentation for this class was generated from the following file:
Generated on Wed May 16 2012 10:16:06 for OpenNI 1.5.4 by   doxygen