thread.h

Go to the documentation of this file.

/* SPDX-License-Identifier: MIT */
#ifndef AJA_THREAD_H
#define AJA_THREAD_H
 
#include "ajabase/common/public.h"
 
// forward declarations
class AJAThread;
class AJAThreadImpl;
 
 
typedef void AJAThreadFunction(AJAThread* pThread, void* pContext);
 
enum AJAThreadState
{
    AJA_ThreadState_Running,
    AJA_ThreadState_Idle,
    AJA_ThreadState_Shutdown
};
 
 
enum AJAThreadPriority
{
    AJA_ThreadPriority_Unknown,         
    AJA_ThreadPriority_Low,             
    AJA_ThreadPriority_Normal,          
    AJA_ThreadPriority_High,            
    AJA_ThreadPriority_TimeCritical,    
    AJA_ThreadPriority_AboveNormal      
};
 
 
enum AJAThreadRealTimePolicy
{
    AJA_ThreadRealTimePolicyFIFO,
    AJA_ThreadRealTimePolicyRoundRobin
};
 
 
class AJA_EXPORT AJAThread
{
public:
 
    AJAThread();
    virtual ~AJAThread();
    
    virtual AJAStatus Start();
 
    virtual AJAStatus Stop(uint32_t timeout = 0xffffffff);
 
    virtual AJAStatus Kill(uint32_t exitCode);
 
    virtual bool Active();
 
    virtual bool IsCurrentThread();
 
    virtual AJAStatus SetPriority(AJAThreadPriority priority);
 
    virtual AJAStatus GetPriority(AJAThreadPriority* pPriority);
 
    virtual AJAStatus SetRealTime(AJAThreadRealTimePolicy policy, int priority);
 
    virtual AJAStatus ThreadRun();
 
    virtual AJAStatus ThreadInit();
 
    virtual bool ThreadLoop();
 
    virtual AJAStatus ThreadFlush();
 
    virtual bool Terminate();
 
    virtual AJAStatus Attach(AJAThreadFunction* pThreadFunction, void* pUserContext);
 
    virtual AJAStatus SetThreadName(const char *name);
 
    static uint64_t GetThreadId();
 
private:
 
    AJAThreadImpl* mpImpl;
};
 
#endif  //  AJA_THREAD_H