ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/svn/vendor/libpeak-0.1.2/doc/html/group__task__timer.html
Revision: 3251
Committed: Wed Apr 2 16:58:30 2014 UTC (12 years, 3 months ago) by michael
Content type: text/html
File size: 5801 byte(s)
Log Message: 
- Imported libpeak-0.1.2

File Contents

# User Rev Content
1 michael 3251 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2     <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3     <title>PEAK Library: Task and timer</title>
4     <link href="doxygen.css" rel="stylesheet" type="text/css">
5     </head><body>
6     <!-- Generated by Doxygen 1.3.5 -->
7     <div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a></div>
8     <h1>Task and timer<br>
9     <small>
10     [<a class="el" href="group__task.html">Task</a>]</small>
11     </h1><hr><a name="_details"></a><h2>Detailed Description</h2>
12     Timers are special objects which must be explicitely added to the task. See <a class="el" href="group__timer.html#ga9">peak_timer_create()</a> and other timer functions for more info.
13     <p>
14     <table border=0 cellpadding=0 cellspacing=0>
15     <tr><td></td></tr>
16     <tr><td colspan=2><br><h2>Functions</h2></td></tr>
17     <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__task__timer.html#ga0">peak_task_timer_add</a> (<a class="el" href="group__task__common.html#ga0">peak_task</a> task, <a class="el" href="group__timer.html#ga0">peak_timer</a> ti)</td></tr>
18    
19     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add a peak timer. <a href="#ga0"></a><br><br></td></tr>
20     <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__task__timer.html#ga1">peak_task_timer_remove</a> (<a class="el" href="group__task__common.html#ga0">peak_task</a> task, <a class="el" href="group__timer.html#ga0">peak_timer</a> ti)</td></tr>
21    
22     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remove a peak timer. <a href="#ga1"></a><br><br></td></tr>
23     </table>
24     <hr><h2>Function Documentation</h2>
25     <a class="anchor" name="ga0" doxytag="task.h::peak_task_timer_add" ></a><p>
26     <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
27     <tr>
28     <td class="mdRow">
29     <table cellpadding="0" cellspacing="0" border="0">
30     <tr>
31     <td class="md" nowrap valign="top"> void peak_task_timer_add </td>
32     <td class="md" valign="top">(&nbsp;</td>
33     <td class="md" nowrap valign="top"><a class="el" href="group__task__common.html#ga0">peak_task</a>&nbsp;</td>
34     <td class="mdname" nowrap> <em>task</em>, </td>
35     </tr>
36     <tr>
37     <td></td>
38     <td></td>
39     <td class="md" nowrap><a class="el" href="group__timer.html#ga0">peak_timer</a>&nbsp;</td>
40     <td class="mdname" nowrap> <em>ti</em></td>
41     </tr>
42     <tr>
43     <td></td>
44     <td class="md">)&nbsp;</td>
45     <td class="md" colspan="2"></td>
46     </tr>
47    
48     </table>
49     </td>
50     </tr>
51     </table>
52     <table cellspacing=5 cellpadding=0 border=0>
53     <tr>
54     <td>
55     &nbsp;
56     </td>
57     <td>
58    
59     <p>
60     Add a peak timer.
61     <p>
62     Add a previously configured peak timer to the specified task. You can create a timer with <a class="el" href="group__timer.html#ga9">peak_timer_create()</a>. This function increases the timer's retain count, so you can safely call <a class="el" href="group__alloc.html#ga7">peak_release()</a> on it if needed. If the timer is already added to a task, then it is first removed then added.<p>
63     <dl compact><dt><b>Parameters:</b></dt><dd>
64     <table border="0" cellspacing="2" cellpadding="0">
65     <tr><td valign=top><em>task</em>&nbsp;</td><td>The task reference. </td></tr>
66     <tr><td valign=top><em>ti</em>&nbsp;</td><td>The timer to add. </td></tr>
67     </table>
68     </dl>
69     </td>
70     </tr>
71     </table>
72     <a class="anchor" name="ga1" doxytag="task.h::peak_task_timer_remove" ></a><p>
73     <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
74     <tr>
75     <td class="mdRow">
76     <table cellpadding="0" cellspacing="0" border="0">
77     <tr>
78     <td class="md" nowrap valign="top"> void peak_task_timer_remove </td>
79     <td class="md" valign="top">(&nbsp;</td>
80     <td class="md" nowrap valign="top"><a class="el" href="group__task__common.html#ga0">peak_task</a>&nbsp;</td>
81     <td class="mdname" nowrap> <em>task</em>, </td>
82     </tr>
83     <tr>
84     <td></td>
85     <td></td>
86     <td class="md" nowrap><a class="el" href="group__timer.html#ga0">peak_timer</a>&nbsp;</td>
87     <td class="mdname" nowrap> <em>ti</em></td>
88     </tr>
89     <tr>
90     <td></td>
91     <td class="md">)&nbsp;</td>
92     <td class="md" colspan="2"></td>
93     </tr>
94    
95     </table>
96     </td>
97     </tr>
98     </table>
99     <table cellspacing=5 cellpadding=0 border=0>
100     <tr>
101     <td>
102     &nbsp;
103     </td>
104     <td>
105    
106     <p>
107     Remove a peak timer.
108     <p>
109     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.<p>
110     <dl compact><dt><b>Parameters:</b></dt><dd>
111     <table border="0" cellspacing="2" cellpadding="0">
112     <tr><td valign=top><em>task</em>&nbsp;</td><td>The task reference. </td></tr>
113     <tr><td valign=top><em>ti</em>&nbsp;</td><td>The timer to remove. </td></tr>
114     </table>
115     </dl>
116     </td>
117     </tr>
118     </table>
119     <hr size="1"><address style="align: right;"><small>Generated on Sat Jan 17 21:41:54 2004 for the PEAK Library by
120     <a href="http://www.doxygen.org/index.html">
121     <img src="doxygen.png" alt="doxygen" align="middle" border="0" >
122     </a></small>&nbsp; &nbsp; <a href="http://sourceforge.net"><img src="http://sourceforge.net/sflogo.php?group_id=98146&amp;type=1" width="88" height="31" align="middle" border="0" alt="SourceForge.net Logo" /></a></address>
123     </body>
124     </html>
125