CascadeThread.h

Go to the documentation of this file.

//
// CascadeThread.h - header file for class CascadeThread
//
// Copyright (c) 2002, Roku, LLC.  All rights reserved.
//

#ifndef _ROKU_INCLUDE_CASCADE_INTERTHREAD_CASCADETHREAD_H
#define _ROKU_INCLUDE_CASCADE_INTERTHREAD_CASCADETHREAD_H

#include <cascade/CascadeObject.h>

class CascadeThread : public CascadeObject
{
protected:
    virtual void ThreadProc() = 0;

public:
    // construction
        CascadeThread();  
        virtual ~CascadeThread();
            
public:
    // simple thread control
    bool Start(bool bDetached = false);
    bool WaitUntilFinished();
    bool Detach();
public:
    // general thread utility functions
    static void Sleep(u32 nMilliseconds);
    static u32 GetCurrentThreadID();
    u32 GetThreadID();
     void SetName(const char * pName);
     void GetName(char * pBuff, u32 nBuffLen);

public:
    // advanced functions dealing with real time thread priorities
    // (only available to processes with superuser priviliges)
    bool SetRealtimePriority(int nPriority);
    bool GetRealtimePriority(int & nRealtimePriorityToSet);
    bool SetNonRealtime();
    inline bool IsRealtimeThread() { int prio = 0; return GetRealtimePriority(prio); }

    static void GetValidRealtimePriorityRange(int & lowest, int & highest);
    static bool IsValidRealtimePriority(int nPriority);
private:
    class Thread; friend class Thread;
    Thread * m_pThread;

    #ifndef DOXY_SKIP
        // TEMP
        static void TagPrint(const char * pMessage);
            // TagPrint will printf pMessage to stdout, prefaced
            // with the pthread_id of the thread.
    #endif        
};

#endif // #ifndef _ROKU_INCLUDE_CASCADE_INTERTHREAD_CASCADETHREAD_H

//  LOG
//  20-Dec-02   dwoodward       created
//  20-Jan-03   dwoodward       1.0 STATUS: 100% complete
//  05-May-03   dwoodward   doxygenated
//  15-Mar-04   dwoodward   use private nested forward declared class instead of void *
//                          for private impl; added GetCurrentThreadID(), GetThreadID(),
//                          SetName(), GetName()
//  26-Apr-05   dwoodward   added Detach()

---