timer_8h.html 9.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.10"/>
  7. <title>CoffeePi: timer.h File Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/searchdata.js"></script>
  13. <script type="text/javascript" src="search/search.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(function() { init_search(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td id="projectalign" style="padding-left: 0.5em;">
  26. <div id="projectname">CoffeePi
  27. </div>
  28. <div id="projectbrief">Coffee machine control for Raspberry Pi</div>
  29. </td>
  30. </tr>
  31. </tbody>
  32. </table>
  33. </div>
  34. <!-- end header part -->
  35. <!-- Generated by Doxygen 1.8.10 -->
  36. <script type="text/javascript">
  37. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  38. </script>
  39. <div id="navrow1" class="tabs">
  40. <ul class="tablist">
  41. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  42. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  43. <li class="current"><a href="files.html"><span>Files</span></a></li>
  44. <li>
  45. <div id="MSearchBox" class="MSearchBoxInactive">
  46. <span class="left">
  47. <img id="MSearchSelect" src="search/mag_sel.png"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. alt=""/>
  51. <input type="text" id="MSearchField" value="Search" accesskey="S"
  52. onfocus="searchBox.OnSearchFieldFocus(true)"
  53. onblur="searchBox.OnSearchFieldFocus(false)"
  54. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  55. </span><span class="right">
  56. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  57. </span>
  58. </div>
  59. </li>
  60. </ul>
  61. </div>
  62. <div id="navrow2" class="tabs2">
  63. <ul class="tablist">
  64. <li><a href="files.html"><span>File&#160;List</span></a></li>
  65. <li><a href="globals.html"><span>Globals</span></a></li>
  66. </ul>
  67. </div>
  68. <!-- window showing the filter options -->
  69. <div id="MSearchSelectWindow"
  70. onmouseover="return searchBox.OnSearchSelectShow()"
  71. onmouseout="return searchBox.OnSearchSelectHide()"
  72. onkeydown="return searchBox.OnSearchSelectKey(event)">
  73. </div>
  74. <!-- iframe showing the search results (closed by default) -->
  75. <div id="MSearchResultsWindow">
  76. <iframe src="javascript:void(0)" frameborder="0"
  77. name="MSearchResults" id="MSearchResults">
  78. </iframe>
  79. </div>
  80. </div><!-- top -->
  81. <div class="header">
  82. <div class="summary">
  83. <a href="#nested-classes">Data Structures</a> &#124;
  84. <a href="#define-members">Macros</a> &#124;
  85. <a href="#func-members">Functions</a> </div>
  86. <div class="headertitle">
  87. <div class="title">timer.h File Reference</div> </div>
  88. </div><!--header-->
  89. <div class="contents">
  90. <p><a href="timer_8h_source.html">Go to the source code of this file.</a></p>
  91. <table class="memberdecls">
  92. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  93. Data Structures</h2></td></tr>
  94. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtimer.html">timer</a></td></tr>
  95. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Timer Class This class allows the creation of multiple timers that are based by a divider on a single system timer. <a href="classtimer.html#details">More...</a><br /></td></tr>
  96. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. </table><table class="memberdecls">
  98. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
  99. Macros</h2></td></tr>
  100. <tr class="memitem:ad6f1d374549d22100d676d5fcac0a7e5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="timer_8h.html#ad6f1d374549d22100d676d5fcac0a7e5">SIG</a>&#160;&#160;&#160;SIGRTMIN</td></tr>
  101. <tr class="separator:ad6f1d374549d22100d676d5fcac0a7e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:af3ec03c16ee82e8578cfd8fd133d7a6f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="timer_8h.html#af3ec03c16ee82e8578cfd8fd133d7a6f">errExit</a>(msg) &#160;&#160;&#160;do { perror(msg); exit(EXIT_FAILURE); } while (0)</td></tr>
  103. <tr class="separator:af3ec03c16ee82e8578cfd8fd133d7a6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a2694a39dfd1fa087ca6f9f391c91dae7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="timer_8h.html#a2694a39dfd1fa087ca6f9f391c91dae7">CLOCKID</a>&#160;&#160;&#160;CLOCK_REALTIME</td></tr>
  105. <tr class="separator:a2694a39dfd1fa087ca6f9f391c91dae7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. </table><table class="memberdecls">
  107. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  108. Functions</h2></td></tr>
  109. <tr class="memitem:a9e737e3249388fb2e50d868bad69c688"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="timer_8h.html#a9e737e3249388fb2e50d868bad69c688">initTimers</a> (void)</td></tr>
  110. <tr class="memdesc:a9e737e3249388fb2e50d868bad69c688"><td class="mdescLeft">&#160;</td><td class="mdescRight">inits the system timer based on signals <a href="#a9e737e3249388fb2e50d868bad69c688">More...</a><br /></td></tr>
  111. <tr class="separator:a9e737e3249388fb2e50d868bad69c688"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:ae9859727c0e51a70b4ff5f47d2527a77"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="timer_8h.html#ae9859727c0e51a70b4ff5f47d2527a77">nullThread</a> (void *threadid)</td></tr>
  113. <tr class="separator:ae9859727c0e51a70b4ff5f47d2527a77"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. </table>
  115. <h2 class="groupheader">Macro Definition Documentation</h2>
  116. <a class="anchor" id="a2694a39dfd1fa087ca6f9f391c91dae7"></a>
  117. <div class="memitem">
  118. <div class="memproto">
  119. <table class="memname">
  120. <tr>
  121. <td class="memname">#define CLOCKID&#160;&#160;&#160;CLOCK_REALTIME</td>
  122. </tr>
  123. </table>
  124. </div><div class="memdoc">
  125. </div>
  126. </div>
  127. <a class="anchor" id="af3ec03c16ee82e8578cfd8fd133d7a6f"></a>
  128. <div class="memitem">
  129. <div class="memproto">
  130. <table class="memname">
  131. <tr>
  132. <td class="memname">#define errExit</td>
  133. <td>(</td>
  134. <td class="paramtype">&#160;</td>
  135. <td class="paramname">msg</td><td>)</td>
  136. <td>&#160;&#160;&#160;do { perror(msg); exit(EXIT_FAILURE); } while (0)</td>
  137. </tr>
  138. </table>
  139. </div><div class="memdoc">
  140. </div>
  141. </div>
  142. <a class="anchor" id="ad6f1d374549d22100d676d5fcac0a7e5"></a>
  143. <div class="memitem">
  144. <div class="memproto">
  145. <table class="memname">
  146. <tr>
  147. <td class="memname">#define SIG&#160;&#160;&#160;SIGRTMIN</td>
  148. </tr>
  149. </table>
  150. </div><div class="memdoc">
  151. </div>
  152. </div>
  153. <h2 class="groupheader">Function Documentation</h2>
  154. <a class="anchor" id="a9e737e3249388fb2e50d868bad69c688"></a>
  155. <div class="memitem">
  156. <div class="memproto">
  157. <table class="memname">
  158. <tr>
  159. <td class="memname">void initTimers </td>
  160. <td>(</td>
  161. <td class="paramtype">void&#160;</td>
  162. <td class="paramname"></td><td>)</td>
  163. <td></td>
  164. </tr>
  165. </table>
  166. </div><div class="memdoc">
  167. <p>inits the system timer based on signals </p>
  168. </div>
  169. </div>
  170. <a class="anchor" id="ae9859727c0e51a70b4ff5f47d2527a77"></a>
  171. <div class="memitem">
  172. <div class="memproto">
  173. <table class="memname">
  174. <tr>
  175. <td class="memname">void* nullThread </td>
  176. <td>(</td>
  177. <td class="paramtype">void *&#160;</td>
  178. <td class="paramname"><em>threadid</em></td><td>)</td>
  179. <td></td>
  180. </tr>
  181. </table>
  182. </div><div class="memdoc">
  183. </div>
  184. </div>
  185. </div><!-- contents -->
  186. <!-- start footer part -->
  187. <hr class="footer"/><address class="footer"><small>
  188. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  189. <img class="footer" src="doxygen.png" alt="doxygen"/>
  190. </a> 1.8.10
  191. </small></address>
  192. </body>
  193. </html>