CATThread.h

Go to the documentation of this file.

//---------------------------------------------------------------------------
/// \file    CATThread.h
/// \brief   Base Thread Class
/// \ingroup CAT
///
/// Copyright (c) 2003-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 CATThread_H
#define CATThread_H
#include "CATInternal.h"

/// \class   CATThread
/// \brief   Base Thread Class
/// \ingroup CAT
///
/// CATThread is your basic thread class.  You can derive classes from it or
/// use as-is with a user-defined CATTHREADPROC
class CATThread
{
    public:
        typedef  void (*CATTHREADPROC)(void *param, CATThread* theThread);

        /// Thread construction
        CATThread();

        /// Thread destruction
        virtual ~CATThread();
        
        /// Start a thread. This is the one used if you're deriving from
        /// CATThread for your own threaded class.  Override ThreadFunction()
        /// for your subclass...
        virtual  bool Start(void *param);

        /// Start a thread procedure.  You can use this directly w/o deriving
        /// just by creating your procedure from the CATTHREADPROC prototype.
        virtual  bool StartProc(CATTHREADPROC proc, void* param);
        
        /// Wait until the thread stops or the timer times out.
        /// If successful, clears the thread handle. Start or StartProc must
        /// be called before other thread commands are used.
        virtual  bool WaitStop(CATUInt32  timeout  = (CATUInt32)-1,
                               CATUInt32* exitCode = 0);

        /// Forces a thread to stop - use sparingly.  As WaitStop does, this
        /// one clears the thread handle.  Start or StartProc must be called
        /// prior to calling other commands after ForceStop is issued.
        virtual  void ForceStop();

        /// Pause the thread. Thread must have been started before use.
        virtual  bool Pause();

        /// Resume the thread. Thread must have been started before use.
        virtual  bool Resume();
        
    protected:
        /// Thread function - either override this if you are deriving
        /// from the class, or leave as is and it will call the CATTHREADPROC
        /// procedure from a StartProc, then exit.
        virtual void ThreadFunction();

        /// OS specific thread - note, the param is NOT the user param, 
        /// rather it is a pointer to the thread object....
        static unsigned int _stdcall W32ThreadProc(void *param);

        CATUInt32       fThreadId;          ///< thread id
        HANDLE          fThreadHandle;      ///< Thread handle
        CATTHREADPROC   fCallback;          ///< Callback
        void*           fUserParam;         ///< User parameter for thread
};

#endif //CATThread_H

---