a00157.html 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108
  1. <!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>uIP 1.0: Clock interface</title>
  4. <link href="doxygen.css" rel="stylesheet" type="text/css">
  5. <link href="tabs.css" rel="stylesheet" type="text/css">
  6. </head><body>
  7. <!-- Generated by Doxygen 1.4.6 -->
  8. <div class="tabs">
  9. <ul>
  10. <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
  11. <li><a href="modules.html"><span>Modules</span></a></li>
  12. <li><a href="classes.html"><span>Data&nbsp;Structures</span></a></li>
  13. <li><a href="files.html"><span>Files</span></a></li>
  14. <li><a href="examples.html"><span>Examples</span></a></li>
  15. </ul></div>
  16. <h1>Clock interface</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
  17. The clock interface is the interface between the <a class="el" href="a00156.html">timer library</a> and the platform specific clock functionality.
  18. <p>
  19. The clock interface must be implemented for each platform that uses the <a class="el" href="a00156.html">timer library</a>.<p>
  20. The clock interface does only one this: it measures time. The clock interface provides a macro, CLOCK_SECOND, which corresponds to one second of system time.<p>
  21. <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a00156.html">Timer library</a> </dd></dl>
  22. <p>
  23. <table border="0" cellpadding="0" cellspacing="0">
  24. <tr><td></td></tr>
  25. <tr><td colspan="2"><br><h2>Defines</h2></td></tr>
  26. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ge3ced0551b26c9b99cb45a86f34d100a"></a><!-- doxytag: member="clock::CLOCK_SECOND" ref="ge3ced0551b26c9b99cb45a86f34d100a" args="" -->
  27. #define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00157.html#ge3ced0551b26c9b99cb45a86f34d100a">CLOCK_SECOND</a></td></tr>
  28. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A second, measured in system clock time. <br></td></tr>
  29. <tr><td colspan="2"><br><h2>Functions</h2></td></tr>
  30. <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00157.html#g78ab77b57cf2e00089f0a3a22508524c">clock_init</a> (void)</td></tr>
  31. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the clock library. <a href="#g78ab77b57cf2e00089f0a3a22508524c"></a><br></td></tr>
  32. <tr><td class="memItemLeft" nowrap align="right" valign="top">clock_time_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00157.html#ge5b7160f2e653725ba5e2024c3cb7bff">clock_time</a> (void)</td></tr>
  33. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the current clock time. <a href="#ge5b7160f2e653725ba5e2024c3cb7bff"></a><br></td></tr>
  34. </table>
  35. <hr><h2>Function Documentation</h2>
  36. <a class="anchor" name="g78ab77b57cf2e00089f0a3a22508524c"></a><!-- doxytag: member="clock.h::clock_init" ref="g78ab77b57cf2e00089f0a3a22508524c" args="(void)" --><p>
  37. <table class="mdTable" cellpadding="2" cellspacing="0">
  38. <tr>
  39. <td class="mdRow">
  40. <table cellpadding="0" cellspacing="0" border="0">
  41. <tr>
  42. <td class="md" nowrap valign="top">void clock_init </td>
  43. <td class="md" valign="top">(&nbsp;</td>
  44. <td class="md" nowrap valign="top">void&nbsp;</td>
  45. <td class="mdname1" valign="top" nowrap> </td>
  46. <td class="md" valign="top">&nbsp;)&nbsp;</td>
  47. <td class="md" nowrap></td>
  48. </tr>
  49. </table>
  50. </td>
  51. </tr>
  52. </table>
  53. <table cellspacing="5" cellpadding="0" border="0">
  54. <tr>
  55. <td>
  56. &nbsp;
  57. </td>
  58. <td>
  59. <p>
  60. Initialize the clock library.
  61. <p>
  62. This function initializes the clock library and should be called from the main() function of the system. </td>
  63. </tr>
  64. </table>
  65. <a class="anchor" name="ge5b7160f2e653725ba5e2024c3cb7bff"></a><!-- doxytag: member="clock.h::clock_time" ref="ge5b7160f2e653725ba5e2024c3cb7bff" args="(void)" --><p>
  66. <table class="mdTable" cellpadding="2" cellspacing="0">
  67. <tr>
  68. <td class="mdRow">
  69. <table cellpadding="0" cellspacing="0" border="0">
  70. <tr>
  71. <td class="md" nowrap valign="top">clock_time_t clock_time </td>
  72. <td class="md" valign="top">(&nbsp;</td>
  73. <td class="md" nowrap valign="top">void&nbsp;</td>
  74. <td class="mdname1" valign="top" nowrap> </td>
  75. <td class="md" valign="top">&nbsp;)&nbsp;</td>
  76. <td class="md" nowrap></td>
  77. </tr>
  78. </table>
  79. </td>
  80. </tr>
  81. </table>
  82. <table cellspacing="5" cellpadding="0" border="0">
  83. <tr>
  84. <td>
  85. &nbsp;
  86. </td>
  87. <td>
  88. <p>
  89. Get the current clock time.
  90. <p>
  91. This function returns the current system clock time.<p>
  92. <dl compact><dt><b>Returns:</b></dt><dd>The current clock time, measured in system ticks. </dd></dl>
  93. <p>
  94. Referenced by <a class="el" href="a00195.html#l00121">timer_expired()</a>, <a class="el" href="a00195.html#l00104">timer_restart()</a>, and <a class="el" href="a00195.html#l00064">timer_set()</a>. </td>
  95. </tr>
  96. </table>
  97. <hr size="1"><address style="align: right;"><small>Generated on Mon Jun 12 10:23:02 2006 for uIP 1.0 by&nbsp;
  98. <a href="http://www.doxygen.org/index.html">
  99. <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
  100. </body>
  101. </html>