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