| 1 |
\hypertarget{group__task__timer}{ |
| 2 |
\section{Task and timer} |
| 3 |
\label{group__task__timer}\index{Task and timer@{Task and timer}} |
| 4 |
} |
| 5 |
|
| 6 |
|
| 7 |
\subsection{Detailed Description} |
| 8 |
Timers are special objects which must be explicitely added to the task. See \hyperlink{group__timer_ga9}{peak\_\-timer\_\-create()} and other timer functions for more info. |
| 9 |
|
| 10 |
\subsection*{Functions} |
| 11 |
\begin{CompactItemize} |
| 12 |
\item |
| 13 |
void \hyperlink{group__task__timer_ga0}{peak\_\-task\_\-timer\_\-add} (\hyperlink{group__task__common_ga0}{peak\_\-task} task, \hyperlink{group__timer_ga0}{peak\_\-timer} ti) |
| 14 |
\begin{CompactList}\small\item\em Add a peak timer. \item\end{CompactList}\item |
| 15 |
void \hyperlink{group__task__timer_ga1}{peak\_\-task\_\-timer\_\-remove} (\hyperlink{group__task__common_ga0}{peak\_\-task} task, \hyperlink{group__timer_ga0}{peak\_\-timer} ti) |
| 16 |
\begin{CompactList}\small\item\em Remove a peak timer. \item\end{CompactList}\end{CompactItemize} |
| 17 |
|
| 18 |
|
| 19 |
\subsection{Function Documentation} |
| 20 |
\hypertarget{group__task__timer_ga0}{ |
| 21 |
\index{task_timer@{task\_\-timer}!peak_task_timer_add@{peak\_\-task\_\-timer\_\-add}} |
| 22 |
\index{peak_task_timer_add@{peak\_\-task\_\-timer\_\-add}!task_timer@{task\_\-timer}} |
| 23 |
\subsubsection[peak\_\-task\_\-timer\_\-add]{\setlength{\rightskip}{0pt plus 5cm}void peak\_\-task\_\-timer\_\-add (\hyperlink{group__task__common_ga0}{peak\_\-task} {\em task}, \hyperlink{group__timer_ga0}{peak\_\-timer} {\em ti})}} |
| 24 |
\label{group__task__timer_ga0} |
| 25 |
|
| 26 |
|
| 27 |
Add a peak timer. |
| 28 |
|
| 29 |
Add a previously configured peak timer to the specified task. You can create a timer with \hyperlink{group__timer_ga9}{peak\_\-timer\_\-create()}. This function increases the timer's retain count, so you can safely call \hyperlink{group__alloc_ga7}{peak\_\-release()} on it if needed. If the timer is already added to a task, then it is first removed then added. |
| 30 |
|
| 31 |
\begin{Desc} |
| 32 |
\item[Parameters:] |
| 33 |
\begin{description} |
| 34 |
\item[{\em task}]The task reference. \item[{\em ti}]The timer to add. \end{description} |
| 35 |
\end{Desc} |
| 36 |
\hypertarget{group__task__timer_ga1}{ |
| 37 |
\index{task_timer@{task\_\-timer}!peak_task_timer_remove@{peak\_\-task\_\-timer\_\-remove}} |
| 38 |
\index{peak_task_timer_remove@{peak\_\-task\_\-timer\_\-remove}!task_timer@{task\_\-timer}} |
| 39 |
\subsubsection[peak\_\-task\_\-timer\_\-remove]{\setlength{\rightskip}{0pt plus 5cm}void peak\_\-task\_\-timer\_\-remove (\hyperlink{group__task__common_ga0}{peak\_\-task} {\em task}, \hyperlink{group__timer_ga0}{peak\_\-timer} {\em ti})}} |
| 40 |
\label{group__task__timer_ga1} |
| 41 |
|
| 42 |
|
| 43 |
Remove a peak timer. |
| 44 |
|
| 45 |
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. |
| 46 |
|
| 47 |
\begin{Desc} |
| 48 |
\item[Parameters:] |
| 49 |
\begin{description} |
| 50 |
\item[{\em task}]The task reference. \item[{\em ti}]The timer to remove. \end{description} |
| 51 |
\end{Desc} |
