Task
Used to dispatch work to the thread pool managed by the task manager.
File location: framework/cauldron/framework/inc/core/taskmanager.h
Construction
Return type |
Description |
---|---|
Task ( TaskFunc pTaskFunction, void* pTaskParam = nullptr, TaskCompletionCallback * pCompletionCallback = nullptr )
|
Detailed description
Used to dispatch work to the thread pool managed by the task manager.
Data fields
Type |
Description |
---|---|
TaskFunc |
pTaskFunction
The task to execute.
|
void* |
pTaskParam
Parameters (in the form of a void pointer) to pass to the task (NOTE** calling code is responsible for the memory backing parameter pointer).
|
pTaskCompletionCallback
If this task is part of a larger group of tasks that require post-completion synchronization, they will be associated with a task sync primitive.
|