XnScheduler.h File Reference
#include <XnOS.h>
Go to the source code of this file.
Define Documentation
#define XN_MASK_SCHEDULER "Scheduler" |
Typedef Documentation
Function Documentation
Adds a task to the scheduler.
- Parameters:
-
| pScheduler | [in] The scheduler to handle this task. |
| nInterval | [in] The interval, in milliseconds, in which callback should be called. |
| pCallback | [in] The function to be called when time arrived. |
| pCallbackArg | [in] The argument that will be passed to the callback method. |
| ppTask | [out] Upon successful return, holds a handle to the started task. |
Removes a task from the scheduler.
- Parameters:
-
| pScheduler | [in] The scheduler this task is registered to. |
| ppTask | [in/out] The task to be removed from the scheduler. |
Changes scheduling of a specific task.
- Parameters:
-
| pScheduler | [in] The scheduler this task is registered to. |
| pTask | [in] The task to be removed from the scheduler. |
| nInterval | [in] The new interval to be used. |
Shuts down a scheduler thread. All timers on that scheduler will be stopped.
- Parameters:
-
| ppScheduler | [in/out] A pointer to the scheduler to be shut down. |
Starts a scheduler thread. Multiple timers can be added to the created scheduler.
- Parameters:
-
| ppScheduler | [out] Upon successful return, holds a handle to created scheduler. |