Thread.h

Go to the documentation of this file.

//==---------------------------------------------------------------------------
// Project: uLib utility library.
// Module: Threads that can be safely killed (unlike TerminateThread).
// License: Released under the NNOSL (See NNOSL.txt in the base directory).
//
// Author: Love Nystrom 2017 <neo.love@hotmail.com>
// Author: Based on code by Jeff Richter 1995, published in MSJ March 1996.
//
// Jeff's article contains the following disclaimer:
//
//   The information contained herein is not endorsed by Microsoft.
//   Microsoft makes no warranty as to the accuracy or the completeness of the
//   information. Users are advised that they use this at their own risk.
//
//==---------------------------------------------------------------------------
// NOTE: Thread uses _beginthreadex to start the thread,
// in order to be safe/r with the multithread C runtime library.
// Ergo, end your thread function by returning, never by ExitThread, and never
// kill a Thread with TerminateThread, use Stop (which calls Kill if needed).
//==---------------------------------------------------------------------------
// NOTE: Requires /EHa compiler switch to perform stack unwind correctly.
//==---------------------------------------------------------------------------

#ifdef __cplusplus
#ifndef __Thread_h_incl__
#define __Thread_h_incl__

#include <uLib/Common.h>
#include <Process.h>

#ifdef __GNUC__ // MinGW misses these declarations
  typedef DWORD (WINAPI *PTHREAD_START_ROUTINE)(
      LPVOID lpThreadParameter
      );
  #ifndef ERROR_DBG_RIPEXCEPTION
    #define ERROR_DBG_RIPEXCEPTION  695L
  #endif
#endif

BEGIN_NAMESPACE( uLib ) // Because "Thread" is such an inconspicous Id.

//==---------------------------------------------------------------------------
//==---------------------------------------------------------------------------

//==---------------------------------------------------------------------------
//  SimpleThread
//==---------------------------------------------------------------------------

typedef class SimpleThread* PSimpleThread;


class SimpleThread {
public:
    PVOID    UserData;  
    HANDLE   hThread;   
    volatile DWORD Id;  

    SimpleThread();     
    virtual ~SimpleThread(); 


    bool Start( PTHREAD_START_ROUTINE ThrFunc, DWORD msYield = 100 );


    bool Stop( DWORD msWait = 3000 );


    void Close();
};

#ifndef HAVE_STRUCTURED_EH
// Sorry: So far, I can't get SEH to work with any of my GCC..
// Until I (or some contributor) can, Thread is only available for MSVC and Borland builds.
#else
//==---------------------------------------------------------------------------
//  Thread
//==---------------------------------------------------------------------------

typedef class Thread*  PThread;


class Thread {
public:
    PVOID    UserData;   
    HANDLE   hThread;    
    volatile DWORD idThread; 


    Thread(
        PTHREAD_START_ROUTINE pFunc, 
        SIZE_T  StackSize = 0,       
        DWORD   Flags = 0,           
        PSECURITY_ATTRIBUTES pSec = NULL 
        );
    virtual ~Thread();


    bool SetThreadProc( PTHREAD_START_ROUTINE pFunc );


    bool Start();
    

    bool Stop( DWORD msWait, bool mayNuke = false );


    bool Pause( bool pause );


    bool Kill();


    void DelayDeath( bool enable );

protected:

    virtual DWORD Execute() { return _ThreadFunc( this ); } // Invoke user's function

    PTHREAD_START_ROUTINE _ThreadFunc; 
    PSECURITY_ATTRIBUTES _SecAttr; 
    SIZE_T  _StkSize;       
    DWORD   _Flags;         

private: 
    HANDLE  _hmControl;     // Mutex to coordinate access the other objects.
    HANDLE  _hmDelay;       // Mutex to queue killing when owned.
    HANDLE  _heEnd;         // Event to signal that killing was queued.

    volatile DWORD _DelayCount; // Nesting count for DelayDeath.

    #ifdef INCL_THREAD_W95_SUPPORT
    PVOID   _pThunk;        // Pointer to the SEH thunks.
    HANDLE  _hFileMap;      // File mapping handle.
    static  DWORD _TLSIndex; // Gives static _ForceDeath access to 'this'.
    #endif

    void _Cleanup( bool closeThr = false ); // Close handles.
    static void _ForceDeath( void ); // Raise an exception in the thread.
    static THREADPROC _TProc( PVOID Arg ); // Crucial wrapper.
};

#endif//def HAVE_STRUCTURED_EH
END_NAMESPACE( uLib )
#endif//ndef __Thread_h_incl__
#endif//def __cplusplus
// EOF