XnVMessageListener.h

Go to the documentation of this file.

/*******************************************************************************
*                                                                              *
*   PrimeSense NITE 1.3                                                        *
*   Copyright (C) 2010 PrimeSense Ltd.                                         *
*                                                                              *
*******************************************************************************/


#ifndef _XNV_MESSAGE_LISTENER_H_
#define _XNV_MESSAGE_LISTENER_H_

#include <XnThreadSafeQueue.h>
#include "XnVMessage.h"

class XnVMessageQueue;
class XnVMessageSpecificEvent;
class XnVEvent;

class XNV_NITE_API XnVMessageListener
{
public:
    typedef void (XN_CALLBACK_TYPE* MessageUpdateCB)(XnVMessage* pMessage, void* cxt);
    typedef void (XN_CALLBACK_TYPE* ActivateCB)(void* cxt);
    typedef void (XN_CALLBACK_TYPE* DeactivateCB)(void* cxt);

    XnVMessageListener(const XnChar* strName = "XnVMessageListener");
    virtual ~XnVMessageListener();

    void BaseUpdate(XnVMessage* pMessage);
    virtual void Update(XnVMessage* pMessage) = 0;
    
    virtual void HandleCCMessages(XnVMessage* pMessage);

    virtual void Activate(XnBool bActive) {}

    const XnChar* GetListenerName() const;

    void Run(XnUInt32 nSessionMaxLength = ms_nSessionDefaultLength);
    XnStatus RunAsThread();
    void SetThreadId(XN_THREAD_ID hThread);
    void SetCurrentThread();

    XnCallbackHandle RegisterUpdate(void* cxt, MessageUpdateCB CB);
    XnCallbackHandle RegisterActivate(void* cxt, ActivateCB CB);
    XnCallbackHandle RegisterDeactivate(void* cxt, DeactivateCB CB);

    void UnregisterUpdate(XnCallbackHandle hCB);
    void UnregisterActivate(XnCallbackHandle hCB);
    void UnregisterDeactivate(XnCallbackHandle hCB);

    void SetThreadProtectionQueueMode(XnBool bMode);
    XnBool GetThreadProtectecionQueueMode() const;
    virtual void ClearQueue();
protected:

    XnBool IsInActivityThread() const;

    static XN_THREAD_PROC MessageListenerThread(XN_THREAD_PARAM param);
    void MainLoop();

    XN_THREAD_ID m_hActivityThreadId;

    XN_THREAD_HANDLE m_hActivityThread; // When thread is internal
    XnBool m_bInternalThreadAlive;
    XnBool m_bInternalThreadKill;

    XnBool m_bThreadProtectionQueueMode;

    static const XnUInt32 ms_nSessionDefaultLength;

    XnVMessageQueue* m_pMessageQueue;

    XnVMessageSpecificEvent* m_pUpdateCBs;
    XnVEvent* m_pActivateCBs;
    XnVEvent* m_pDeactivateCBs;

    XnChar* m_strListenerName;

    XN_CRITICAL_SECTION_HANDLE m_hListenerCS;
};

#endif