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: uip/timer.h Source File</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 Page</span></a></li> 11 <li><a href="modules.html"><span>Modules</span></a></li> 12 <li><a href="classes.html"><span>Data Structures</span></a></li> 13 <li id="current"><a href="files.html"><span>Files</span></a></li> 14 <li><a href="examples.html"><span>Examples</span></a></li> 15 </ul></div> 16<div class="tabs"> 17 <ul> 18 <li><a href="files.html"><span>File List</span></a></li> 19 <li><a href="globals.html"><span>Globals</span></a></li> 20 </ul></div> 21<h1>uip/timer.h</h1><a href="a00130.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/**</span> 22<a name="l00002"></a>00002 <span class="comment"> * \defgroup timer Timer library</span> 23<a name="l00003"></a>00003 <span class="comment"> *</span> 24<a name="l00004"></a>00004 <span class="comment"> * The timer library provides functions for setting, resetting and</span> 25<a name="l00005"></a>00005 <span class="comment"> * restarting timers, and for checking if a timer has expired. An</span> 26<a name="l00006"></a>00006 <span class="comment"> * application must "manually" check if its timers have expired; this</span> 27<a name="l00007"></a>00007 <span class="comment"> * is not done automatically.</span> 28<a name="l00008"></a>00008 <span class="comment"> *</span> 29<a name="l00009"></a>00009 <span class="comment"> * A timer is declared as a \c struct \c timer and all access to the</span> 30<a name="l00010"></a>00010 <span class="comment"> * timer is made by a pointer to the declared timer.</span> 31<a name="l00011"></a>00011 <span class="comment"> *</span> 32<a name="l00012"></a>00012 <span class="comment"> * \note The timer library uses the \ref clock "Clock library" to</span> 33<a name="l00013"></a>00013 <span class="comment"> * measure time. Intervals should be specified in the format used by</span> 34<a name="l00014"></a>00014 <span class="comment"> * the clock library.</span> 35<a name="l00015"></a>00015 <span class="comment"> *</span> 36<a name="l00016"></a>00016 <span class="comment"> * @{</span> 37<a name="l00017"></a>00017 <span class="comment"> */</span> 38<a name="l00018"></a>00018 39<a name="l00019"></a>00019 <span class="comment"></span> 40<a name="l00020"></a>00020 <span class="comment">/**</span> 41<a name="l00021"></a>00021 <span class="comment"> * \file</span> 42<a name="l00022"></a>00022 <span class="comment"> * Timer library header file.</span> 43<a name="l00023"></a>00023 <span class="comment"> * \author</span> 44<a name="l00024"></a>00024 <span class="comment"> * Adam Dunkels <[email protected]></span> 45<a name="l00025"></a>00025 <span class="comment"> */</span> 46<a name="l00026"></a>00026 47<a name="l00027"></a>00027 <span class="comment">/*</span> 48<a name="l00028"></a>00028 <span class="comment"> * Copyright (c) 2004, Swedish Institute of Computer Science.</span> 49<a name="l00029"></a>00029 <span class="comment"> * All rights reserved.</span> 50<a name="l00030"></a>00030 <span class="comment"> *</span> 51<a name="l00031"></a>00031 <span class="comment"> * Redistribution and use in source and binary forms, with or without</span> 52<a name="l00032"></a>00032 <span class="comment"> * modification, are permitted provided that the following conditions</span> 53<a name="l00033"></a>00033 <span class="comment"> * are met:</span> 54<a name="l00034"></a>00034 <span class="comment"> * 1. Redistributions of source code must retain the above copyright</span> 55<a name="l00035"></a>00035 <span class="comment"> * notice, this list of conditions and the following disclaimer.</span> 56<a name="l00036"></a>00036 <span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright</span> 57<a name="l00037"></a>00037 <span class="comment"> * notice, this list of conditions and the following disclaimer in the</span> 58<a name="l00038"></a>00038 <span class="comment"> * documentation and/or other materials provided with the distribution.</span> 59<a name="l00039"></a>00039 <span class="comment"> * 3. Neither the name of the Institute nor the names of its contributors</span> 60<a name="l00040"></a>00040 <span class="comment"> * may be used to endorse or promote products derived from this software</span> 61<a name="l00041"></a>00041 <span class="comment"> * without specific prior written permission.</span> 62<a name="l00042"></a>00042 <span class="comment"> *</span> 63<a name="l00043"></a>00043 <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND</span> 64<a name="l00044"></a>00044 <span class="comment"> * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span> 65<a name="l00045"></a>00045 <span class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span> 66<a name="l00046"></a>00046 <span class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE</span> 67<a name="l00047"></a>00047 <span class="comment"> * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL</span> 68<a name="l00048"></a>00048 <span class="comment"> * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS</span> 69<a name="l00049"></a>00049 <span class="comment"> * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)</span> 70<a name="l00050"></a>00050 <span class="comment"> * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT</span> 71<a name="l00051"></a>00051 <span class="comment"> * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY</span> 72<a name="l00052"></a>00052 <span class="comment"> * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF</span> 73<a name="l00053"></a>00053 <span class="comment"> * SUCH DAMAGE.</span> 74<a name="l00054"></a>00054 <span class="comment"> *</span> 75<a name="l00055"></a>00055 <span class="comment"> * This file is part of the uIP TCP/IP stack</span> 76<a name="l00056"></a>00056 <span class="comment"> *</span> 77<a name="l00057"></a>00057 <span class="comment"> * Author: Adam Dunkels <[email protected]></span> 78<a name="l00058"></a>00058 <span class="comment"> *</span> 79<a name="l00059"></a>00059 <span class="comment"> * $Id: timer.h,v 1.3 2006/06/11 21:46:39 adam Exp $</span> 80<a name="l00060"></a>00060 <span class="comment"> */</span> 81<a name="l00061"></a>00061 <span class="preprocessor">#ifndef __TIMER_H__</span> 82<a name="l00062"></a>00062 <span class="preprocessor"></span><span class="preprocessor">#define __TIMER_H__</span> 83<a name="l00063"></a>00063 <span class="preprocessor"></span> 84<a name="l00064"></a>00064 <span class="preprocessor">#include "clock.h"</span> 85<a name="l00065"></a>00065 <span class="comment"></span> 86<a name="l00066"></a>00066 <span class="comment">/**</span> 87<a name="l00067"></a>00067 <span class="comment"> * A timer.</span> 88<a name="l00068"></a>00068 <span class="comment"> *</span> 89<a name="l00069"></a>00069 <span class="comment"> * This structure is used for declaring a timer. The timer must be set</span> 90<a name="l00070"></a>00070 <span class="comment"> * with timer_set() before it can be used.</span> 91<a name="l00071"></a>00071 <span class="comment"> *</span> 92<a name="l00072"></a>00072 <span class="comment"> * \hideinitializer</span> 93<a name="l00073"></a>00073 <span class="comment"> */</span> 94<a name="l00074"></a><a class="code" href="a00087.html">00074</a> <span class="keyword">struct </span><a class="code" href="a00087.html">timer</a> { 95<a name="l00075"></a><a class="code" href="a00087.html#e8eb428c05bc1dee022246a3063d277c">00075</a> clock_time_t <a class="code" href="a00087.html#e8eb428c05bc1dee022246a3063d277c">start</a>; 96<a name="l00076"></a><a class="code" href="a00087.html#fe557d333c06cf65f52023f45f5b0a3a">00076</a> clock_time_t <a class="code" href="a00087.html#fe557d333c06cf65f52023f45f5b0a3a">interval</a>; 97<a name="l00077"></a>00077 }; 98<a name="l00078"></a>00078 99<a name="l00079"></a>00079 <span class="keywordtype">void</span> <a class="code" href="a00156.html#g6614d96fdfcd95c95ec6e6f63071ff51">timer_set</a>(<span class="keyword">struct</span> <a class="code" href="a00087.html">timer</a> *t, clock_time_t interval); 100<a name="l00080"></a>00080 <span class="keywordtype">void</span> <a class="code" href="a00156.html#gedaf3e48c2b04229b85455fb948468d6">timer_reset</a>(<span class="keyword">struct</span> <a class="code" href="a00087.html">timer</a> *t); 101<a name="l00081"></a>00081 <span class="keywordtype">void</span> <a class="code" href="a00156.html#gcb807bd57e5489b386b876af5c1f163a">timer_restart</a>(<span class="keyword">struct</span> <a class="code" href="a00087.html">timer</a> *t); 102<a name="l00082"></a>00082 <span class="keywordtype">int</span> <a class="code" href="a00156.html#g6d71dececfce707c668e6257aad5906e">timer_expired</a>(<span class="keyword">struct</span> <a class="code" href="a00087.html">timer</a> *t); 103<a name="l00083"></a>00083 104<a name="l00084"></a>00084 <span class="preprocessor">#endif </span><span class="comment">/* __TIMER_H__ */</span> 105<a name="l00085"></a>00085 <span class="comment"></span> 106<a name="l00086"></a>00086 <span class="comment">/** @} */</span> 107</pre></div><hr size="1"><address style="align: right;"><small>Generated on Mon Jun 12 10:23:01 2006 for uIP 1.0 by 108<a href="http://www.doxygen.org/index.html"> 109<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> 110</body> 111</html> 112
