TaskWorkerThread.h

#pragma once
 
#include <Foundation/Threading/Implementation/TaskSystemDeclarations.h>
 
#include <Foundation/Threading/Thread.h>
#include <Foundation/Threading/ThreadSignal.h>
 
class plTaskWorkerThread final : public plThread
{
  PL_DISALLOW_COPY_AND_ASSIGN(plTaskWorkerThread);
 
 
public:
  plTaskWorkerThread(plWorkerThreadType::Enum threadType, plUInt32 uiThreadNumber);
  ~plTaskWorkerThread();
 
  plResult DeactivateWorker();
 
private:
  // Which types of tasks this thread should work on.
  plWorkerThreadType::Enum m_WorkerType;
 
  // Whether the thread is supposed to continue running.
  volatile bool m_bActive = true;
 
  // For display purposes.
  plUInt16 m_uiWorkerThreadNumber = 0xFFFF;
 
 
 
public:
  double GetThreadUtilization(plUInt32* pNumTasksExecuted = nullptr);
 
  void UpdateThreadUtilization(plTime timePassed);
 
private:
  bool m_bExecutingTask = false;
  plUInt16 m_uiLastNumTasksExecuted = 0;
  plUInt16 m_uiNumTasksExecuted = 0;
  plTime m_StartedWorkingTime;
  plTime m_ThreadActiveTime;
  double m_fLastThreadUtilization = 0.0;
 
 
 
public:
  plTaskWorkerState WakeUpIfIdle();
 
private:
  // Puts the thread to sleep (idle state)
  void WaitForWork();
 
  virtual plUInt32 Run() override;
 
  // used to wake up idle threads, see m_WorkerState
  plThreadSignal m_WakeUpSignal;
 
  // used to indicate whether this thread is currently idle
  // if so, it can be woken up using m_WakeUpSignal
  // plAtomicBool m_bIsIdle = false;
  plAtomicInteger32 m_iWorkerState; // plTaskWorkerState
 
};
 
struct plTaskWorkerInfo
{
  plWorkerThreadType::Enum m_WorkerType = plWorkerThreadType::Unknown;
  bool m_bAllowNestedTasks = true;
  plInt32 m_iWorkerIndex = -1;
  const char* m_szTaskName = nullptr;
  plAtomicInteger32* m_pWorkerState = nullptr;
};
 
extern thread_local plTaskWorkerInfo tl_TaskWorkerInfo;