CATMsgThread.h

Go to the documentation of this file.

//---------------------------------------------------------------------------
/// \file    CATMsgThread.h
/// \brief   Message Thread Base Class
/// \ingroup CAT
///
/// Copyright (c) 2008 by Michael Ellison.
/// See COPYING.txt for the \ref gaslicense License (MIT License).
///
// $Author: mikeellison $
// $Date: 2008-01-23 08:59:02 -0600 (Wed, 23 Jan 2008) $
// $Revision:   $
// $NoKeywords: $
//---------------------------------------------------------------------------

#ifndef CATMsgThread_H_
#define CATMsgThread_H_

#include "CATThread.h"
#include "CATSignal.h"

/// \class   CATMsgThread
/// \brief   Message Thread Base Class
/// \ingroup CAT
///
/// CATMsgThread is the class to inherit from when you want a thread
/// that responds to messages and has a periodic loop.
class CATMsgThread : protected CATThread
{
    public:
        /// Thread construction
        CATMsgThread();

        /// Thread destruction
        virtual ~CATMsgThread();
        
        /// Start a thread. 
        virtual  bool Start( CATUInt32 pollFreq);

        /// Stop a thread, cleanly if possible.
        virtual  void Stop ( CATUInt32 timeout = (CATUInt32)-1);

        /// Called once per timeout
        virtual  void OnThreadIdle();

        /// Called when messages are received
        virtual  CATUInt32 OnThreadMessage(CATUInt32 msg, CATUInt32 wParam, CATUInt32 lParam);

        /// Posts a message to the thread
        bool     Post(CATUInt32 msg, CATUInt32 wParam, CATUInt32 lParam);
    
    protected:
        virtual void ThreadFunction();
        CATUInt32    fPollFreq;
        CATSignal    fExitSignal;
};

#endif //CATMsgThread_H_

---