Cogs.Core
Public Member Functions | Public Attributes | List of all members
Cogs::Core::TaskWorker Class Reference

Task worker executing Task instances retrieved from a TaskQueue. More...

Public Member Functions

 TaskWorker (TaskQueue *taskQueue, uint32_t workerIx, const std::string &name)
 Construct a TaskWorker with the given taskQueue.
 
void operator() ()
 Executes the task worker.
 

Public Attributes

TaskQueuetaskQueue
 Task queue to retrieve Task instances from.
 
uint32_t workerIx = 0
 
std::string name
 

Detailed Description

Task worker executing Task instances retrieved from a TaskQueue.

Definition at line 635 of file TaskManager.cpp.

Constructor & Destructor Documentation

◆ TaskWorker()

Cogs::Core::TaskWorker::TaskWorker ( TaskQueue taskQueue,
uint32_t  workerIx,
const std::string &  name 
)
inline

Construct a TaskWorker with the given taskQueue.

Definition at line 639 of file TaskManager.cpp.

Member Function Documentation

◆ operator()()

void Cogs::Core::TaskWorker::operator() ( )
inline

Executes the task worker.

The worker will loop as long as there are available tasks from the TaskQueue.

Definition at line 648 of file TaskManager.cpp.

References Cogs::Core::TaskQueue::getNextTask(), taskQueue, and Cogs::Core::TaskQueue::workOnTask().

Member Data Documentation

◆ name

std::string Cogs::Core::TaskWorker::name

Definition at line 667 of file TaskManager.cpp.

◆ taskQueue

TaskQueue* Cogs::Core::TaskWorker::taskQueue

Task queue to retrieve Task instances from.

Definition at line 665 of file TaskManager.cpp.

Referenced by operator()().

◆ workerIx

uint32_t Cogs::Core::TaskWorker::workerIx = 0

Definition at line 666 of file TaskManager.cpp.


The documentation for this class was generated from the following file: