Main Page | Modules | Data Structures | Data Fields

Task and timer
[Task]


Detailed Description

Timers are special objects which must be explicitely added to the task. See peak_timer_create() and other timer functions for more info.


Functions

void peak_task_timer_add (peak_task task, peak_timer ti)
 Add a peak timer.

void peak_task_timer_remove (peak_task task, peak_timer ti)
 Remove a peak timer.


Function Documentation

void peak_task_timer_add peak_task  task,
peak_timer  ti
 

Add a peak timer.

Add a previously configured peak timer to the specified task. You can create a timer with peak_timer_create(). This function increases the timer's retain count, so you can safely call peak_release() on it if needed. If the timer is already added to a task, then it is first removed then added.

Parameters:
task The task reference.
ti The timer to add.

void peak_task_timer_remove peak_task  task,
peak_timer  ti
 

Remove a peak timer.

Remove a timer previously added to the task and decrease its retain count. If the retain count is 0 then the timer is deleted. If the timer wasn't previously added to the task, then this function does nothing.

Parameters:
task The task reference.
ti The timer to remove.


Generated on Sat Jan 17 21:41:54 2004 for the PEAK Library by doxygen     SourceForge.net Logo