JenovaSDK API Reference
Developed by Hamid.Memar (MemarDesign™ LLC.)
 
Loading...
Searching...
No Matches
Task System Utilities

Functions

TaskID InitiateTask (TaskFunction function)
 Starts a background task in a new thread.
 
bool IsTaskComplete (TaskID taskID)
 Checks if a task is complete and finished.
 
void ClearTask (TaskID taskID)
 Clears a completed task and shutdowns the thread.
 

Detailed Description

This collection of functions provides a set of utilities for managing multi-threaded tasks, including initiation, completion checks and clearing.

Powered by libpthread

Function Documentation

◆ InitiateTask()

TaskID InitiateTask ( TaskFunction function)

Starts a background task in a new thread.

Parameters
functionThe function to initiate the task with.
Returns
The initiated task Unique ID.

◆ IsTaskComplete()

bool IsTaskComplete ( TaskID taskID)

Checks if a task is complete and finished.

Parameters
taskIDThe Unique ID of the task to check.
Returns
true if the task is complete, false otherwise.

◆ ClearTask()

void ClearTask ( TaskID taskID)

Clears a completed task and shutdowns the thread.

Parameters
taskIDThe Unique ID of the task to clear.