XnThreadSafeQueue.h
Go to the documentation of this file.
/****************************************************************************
* *
* OpenNI 1.x Alpha *
* Copyright (C) 2011 PrimeSense Ltd. *
* *
* This file is part of OpenNI. *
* *
* OpenNI is free software: you can redistribute it and/or modify *
* it under the terms of the GNU Lesser General Public License as published *
* by the Free Software Foundation, either version 3 of the License, or *
* (at your option) any later version. *
* *
* OpenNI is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU Lesser General Public License *
* along with OpenNI. If not, see <http://www.gnu.org/licenses/>. *
* *
****************************************************************************/
#ifndef __XN_THREAD_SAFE_QUEUE_H__
#define __XN_THREAD_SAFE_QUEUE_H__
//---------------------------------------------------------------------------
// Includes
//---------------------------------------------------------------------------
#include <XnQueue.h>
#include <XnOS.h>
//---------------------------------------------------------------------------
// Types
//---------------------------------------------------------------------------
class XnThreadSafeQueue : public XnQueue
{
public:
XnThreadSafeQueue() : m_hLock(NULL) {}
~XnThreadSafeQueue()
{
xnOSCloseCriticalSection(&m_hLock);
}
XnStatus Init()
{
XnStatus nRetVal = XN_STATUS_OK;
nRetVal = xnOSCreateCriticalSection(&m_hLock);
XN_IS_STATUS_OK(nRetVal);
return (XN_STATUS_OK);
}
XnStatus Push(XnValue const& value)
{
XnStatus nRetVal = XN_STATUS_OK;
nRetVal = xnOSEnterCriticalSection(&m_hLock);
XN_IS_STATUS_OK(nRetVal);
nRetVal = XnQueue::Push(value);
xnOSLeaveCriticalSection(&m_hLock);
return nRetVal;
}
XnStatus Pop(XnValue& value)
{
XnStatus nRetVal = XN_STATUS_OK;
nRetVal = xnOSEnterCriticalSection(&m_hLock);
XN_IS_STATUS_OK(nRetVal);
nRetVal = XnQueue::Pop(value);
xnOSLeaveCriticalSection(&m_hLock);
return nRetVal;
}
XnUInt32 Size() const
{
xnOSEnterCriticalSection(&m_hLock);
XnUInt32 nSize = XnQueue::Size();
xnOSLeaveCriticalSection(&m_hLock);
return (nSize);
}
private:
// NOTE: we declare the lock as mutable, as it may change on const methods.
mutable XN_CRITICAL_SECTION_HANDLE m_hLock;
};
#define XN_DECLARE_THREAD_SAFE_QUEUE_WITH_TRANSLATOR_DECL(decl, Type, ClassName, Translator) \
class decl ClassName : public XnThreadSafeQueue \
{ \
public: \
~ClassName() \
{ \
/* We do this using Pop() to make sure memory is freed. */ \
Type dummy; \
while (Size() != 0) \
Pop(dummy); \
} \
XnStatus Push(Type const& value) \
{ \
XnValue val = Translator::CreateValueCopy(value); \
XnStatus nRetVal = XnThreadSafeQueue::Push(val); \
if (nRetVal != XN_STATUS_OK) \
{ \
Translator::FreeValue(val); \
return (nRetVal); \
} \
return XN_STATUS_OK; \
} \
XnStatus Pop(Type& value) \
{ \
XnValue val; \
XnStatus nRetVal = XnThreadSafeQueue::Pop(val); \
if (nRetVal != XN_STATUS_OK) return (nRetVal); \
value = Translator::GetFromValue(val); \
Translator::FreeValue(val); \
return XN_STATUS_OK; \
} \
};
#define XN_DECLARE_THREAD_SAFE_QUEUE_WITH_TRANSLATOR(Type, ClassName, Translator) \
XN_DECLARE_THREAD_SAFE_QUEUE_WITH_TRANSLATOR_DECL(, Type, ClassName, Translator)
#define XN_DECLARE_THREAD_SAFE_QUEUE_DECL(decl, Type, ClassName) \
XN_DECLARE_DEFAULT_VALUE_TRANSLATOR_DECL(decl, Type, XN_DEFAULT_TRANSLATOR_NAME(ClassName)) \
XN_DECLARE_THREAD_SAFE_QUEUE_WITH_TRANSLATOR_DECL(decl, Type, ClassName, XN_DEFAULT_TRANSLATOR_NAME(ClassName))
#define XN_DECLARE_THREAD_SAFE_QUEUE(Type, ClassName) \
XN_DECLARE_THREAD_SAFE_QUEUE_DECL(, Type, ClassName)
#endif //__XN_THREAD_SAFE_QUEUE_H__
XnValue
void * XnValue
Definition XnDataTypes.h:36
XN_IS_STATUS_OK
#define XN_IS_STATUS_OK(x)
Definition XnMacros.h:60
XnOS.h
xnOSCloseCriticalSection
XN_C_API XnStatus XN_C_DECL xnOSCloseCriticalSection(XN_CRITICAL_SECTION_HANDLE *pCriticalSectionHandle)
xnOSEnterCriticalSection
XN_C_API XnStatus XN_C_DECL xnOSEnterCriticalSection(XN_CRITICAL_SECTION_HANDLE *pCriticalSectionHandle)
xnOSLeaveCriticalSection
XN_C_API XnStatus XN_C_DECL xnOSLeaveCriticalSection(XN_CRITICAL_SECTION_HANDLE *pCriticalSectionHandle)
xnOSCreateCriticalSection
XN_C_API XnStatus XN_C_DECL xnOSCreateCriticalSection(XN_CRITICAL_SECTION_HANDLE *pCriticalSectionHandle)
XnQueue.h
XnStatus
XnUInt32 XnStatus
Definition XnStatus.h:34
XN_STATUS_OK
#define XN_STATUS_OK
Definition XnStatus.h:37
XnQueue::Pop
virtual XnStatus Pop(XnValue &value)
Definition XnQueue.h:79
XnQueue::XnQueue
XnQueue()
Definition XnQueue.h:42
XnQueue::Size
virtual XnUInt32 Size() const
Definition XnQueue.h:121
XnQueue::Push
virtual XnStatus Push(XnValue const &value)
Definition XnQueue.h:63
XnThreadSafeQueue::Pop
XnStatus Pop(XnValue &value)
Definition XnThreadSafeQueue.h:70
XnThreadSafeQueue::XnThreadSafeQueue
XnThreadSafeQueue()
Definition XnThreadSafeQueue.h:40
XnThreadSafeQueue::~XnThreadSafeQueue
~XnThreadSafeQueue()
Definition XnThreadSafeQueue.h:42
XnThreadSafeQueue::Size
XnUInt32 Size() const
Definition XnThreadSafeQueue.h:83
XnThreadSafeQueue::Init
XnStatus Init()
Definition XnThreadSafeQueue.h:47
XnThreadSafeQueue::Push
XnStatus Push(XnValue const &value)
Definition XnThreadSafeQueue.h:57