XThread.h

#if !defined(XTHREAD_H)
#define XTHREAD_H
 
#ifdef _MSC_VER
#pragma once
#endif // _MSC_VER
 
#include "xosoperation.h"
 
BEGIN_MOOTOOLS_NAMESPACE
 
class CXCriticalSection;
class DLL_TOOLSFUNCTION CXThread : public CXObject
{
    DECLARE_DYNAMIC_XOBJECT(CXThread)
    
public:
    CXThread(bool autoDelete = true); // Thread delete themselves, unless XTHREAD_PREVENT_AUTODELETE is set when creating the thread
    CXThread(XTHREADPROC threadCallback, void *threadData);
    virtual ~CXThread();
    
    static void SleepCurrentThread(unsigned int milliSeconds);
    static xThreadID GetMainThreadID();
    static xThreadID GetCurrentThreadID();
    static CXThread* BeginThread(CXThread *pThread, xThreadPriority = XTHREAD_PRIORITY_NORMAL, unsigned int createFlags = XTHREAD_DEFAULT, size_t stackSize = 0);
    static CXThread* BeginThread(XTHREADPROC threadCallback, void *pUserThreadData, xThreadPriority = XTHREAD_PRIORITY_NORMAL, unsigned int createFlags = XTHREAD_DEFAULT, size_t stackSize = 0);
    static CXThread *BeginThread(const CXRuntimeClass* pThreadClass, void *pUserThreadData = NULL, xThreadPriority = XTHREAD_PRIORITY_NORMAL, unsigned int createFlags = XTHREAD_DEFAULT, size_t stackSize = 0);
        
    // Operations
    xThreadHandle GetThreadHandle() const;
    xThreadID GetThreadID() const;
    bool IsValidThread() const; // return true if the thread is valid handle.
    bool IsSuspended() const; // return true if the thread is suspended
    bool IsTerminated() const; // Return true if the thread is terminated and can be safely deleted (case autodelete is off)
 
    bool SuspendThread(); // Suspend a running thread only work on Windows OS
    bool ResumeThread(); // Thread can be created suspended then being resumed after its creating
    xThreadPriority GetThreadPriority() const;
    bool SetThreadPriority(xThreadPriority priority); // Thread priority can be modified at runtime on Windows OS
    
    bool ShouldCancel() const; // Return true if someone call to stop
    void SetCancel();
    bool Lock(bool lock) const; // Lock mechanism for accessing the thread from different part
    void SetAutoDelete(bool autoDelete); // Change autodeletion thread status (safe threaded). If set, the caller must take care to do not call the thread externally as it can be deleted at any moment, once it finish its job.
    
    void *GetUserThreadData(); // Return an user data defined at creation
 
protected:
    typedef enum ThreadFlags
    {
        XTHREAD_FLAGS_NONE = 0x00,
        XTHREAD_FLAGS_AUTODELETE = 0x01, // The thread object, is automatically deleted
        XTHREAD_FLAGS_SET_CANCEL = 0x02, // Ask the thread to cancel.
        XTHREAD_FLAGS_IS_CALLBACK = 0x04, // The thread is a XTHREADPROC callback.
        XTHREAD_FLAGS_IS_TERMINATED = 0x08, // The thread is terminated and can be safely deleted
        XTHREAD_IS_NOT_CRITICAL = 0x10, // The thread can be hard terminated "safely"
    } ThreadFlags;
 
    bool AutoDelete(); // Delete only if autoDelete set, return true if deleted
    void SetFlag(ThreadFlags flag, bool set);
    bool IsFlagSet(ThreadFlags flag) const;
 
    virtual bool Start(); // return false means initialization of the thread fails. Run is not called
    virtual void Finish();
    virtual bool Run();
    
private:
    XTHREADPROC userThreadCallback;             // A callback defined by the user, if CXThread if not overidden (otherwise CXThread::Run is called)
    void *userThreadData;
 
    xThreadContext threadContext;       // Handle of this thread, the handle is non null even after thread termination.
    mutable CXCriticalSection *threadLock;
    mutable unsigned int flags;
 
    static bool StaticThreadCallback(void *data);
};
 
END_MOOTOOLS_NAMESPACE
 
#endif // !defined(XTHREAD_H)