doc/generated/html/api/alarm_8h.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
   3 <title>Xenomai API: include/native/alarm.h File Reference</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.5.6 -->
   8 <div class="navigation" id="top">
   9   <div class="tabs">
  10     <ul>
  11       <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
  12       <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  13       <li><a href="modules.html"><span>Modules</span></a></li>
  14       <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
  15       <li class="current"><a href="files.html"><span>Files</span></a></li>
  16       <li><a href="examples.html"><span>Examples</span></a></li>
  17     <li>
  18       <form action="search.php" method="get">
  19         <table cellspacing="0" cellpadding="0" border="0">
  20           <tr>
  21             <td><label>&nbsp;<u>S</u>earch&nbsp;for&nbsp;</label></td>
  22             <td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
  23           </tr>
  24         </table>
  25       </form>
  26     </li>
  27     </ul>
  28   </div>
  29 </div>
  30 <div class="contents">
  31 <h1>include/native/alarm.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
  32 This file is part of the Xenomai project.
  33 <p>
  34 <dl class="note" compact><dt><b>Note:</b></dt><dd>Copyright (C) 2004 Philippe Gerum &lt;<a href="mailto:rpm@xenomai.org">rpm@xenomai.org</a>&gt;</dd></dl>
  35 This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.<p>
  36 This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.<p>
  37 You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  38 <p>
  39
  40 <p>
  41 <div class="dynheader">
  42 Include dependency graph for alarm.h:</div>
  43 <div class="dynsection">
  44 <p><center><img src="alarm_8h__incl.png" border="0" usemap="#include/native/alarm.h_map" alt=""></center>
  45 <map name="include/native/alarm.h_map">
  46 <area shape="rect" href="native_2types_8h.html" title="This file is part of the Xenomai project." alt="" coords="5,548,117,575"><area shape="rect" href="include_2nucleus_2timer_8h.html" title="nucleus/timer.h" alt="" coords="440,393,560,420"><area shape="rect" href="synch_8h-source.html" title="nucleus/synch.h" alt="" coords="729,471,852,497"><area shape="rect" href="native_2ppd_8h.html" title="This file is part of the Xenomai project." alt="" coords="1147,84,1245,111"><area shape="rect" href="nucleus_2types_8h-source.html" title="nucleus/types.h" alt="" coords="449,625,569,652"><area shape="rect" href="compiler_8h-source.html" title="nucleus/compiler.h" alt="" coords="369,703,508,729"><area shape="rect" href="assert_8h-source.html" title="nucleus/assert.h" alt="" coords="655,703,780,729"><area shape="rect" href="timebase_8h.html" title="nucleus/timebase.h" alt="" coords="499,471,645,497"><area shape="rect" href="stat_8h-source.html" title="nucleus/stat.h" alt="" coords="363,471,475,497"><area shape="rect" href="nucleus_2queue_8h-source.html" title="nucleus/queue.h" alt="" coords="728,548,853,575"><area shape="rect" href="pod_8h.html" title="Real&#45;time pod interface header." alt="" coords="1075,161,1184,188"><area shape="rect" href="nucleus_2ppd_8h-source.html" title="nucleus/ppd.h" alt="" coords="1236,161,1345,188"><area shape="rect" href="nucleus_2heap_8h-source.html" title="nucleus/heap.h" alt="" coords="1447,239,1564,265"><area shape="rect" href="sched_8h.html" title="Scheduler interface header." alt="" coords="635,239,757,265"><area shape="rect" href="include_2nucleus_2thread_8h-source.html" title="nucleus/thread.h" alt="" coords="95,316,223,343"><area shape="rect" href="schedqueue_8h-source.html" title="nucleus/schedqueue.h" alt="" coords="887,393,1049,420"><area shape="rect" href="sched-tp_8h.html" title="Definitions for the TP scheduling class." alt="" coords="247,316,388,343"><area shape="rect" href="sched-sporadic_8h.html" title="Definitions for the SSP scheduling class." alt="" coords="412,316,596,343"><area shape="rect" href="sched-idle_8h.html" title="Definitions for the IDLE scheduling class." alt="" coords="620,316,772,343"><area shape="rect" href="sched-rt_8h.html" title="Definitions for the RT scheduling class." alt="" coords="796,316,935,343"><area shape="rect" href="include_2nucleus_2registry_8h.html" title="This file is part of the Xenomai project." alt="" coords="616,393,749,420"><area shape="rect" href="schedparam_8h-source.html" title="nucleus/schedparam.h" alt="" coords="247,393,412,420"><area shape="rect" href="shadow_8h-source.html" title="nucleus/shadow.h" alt="" coords="1224,239,1357,265"></map>
  47 </div>
  48
  49 <p>
  50 <div class="dynheader">
  51 This graph shows which files directly or indirectly include this file:</div>
  52 <div class="dynsection">
  53 <p><center><img src="alarm_8h__dep__incl.png" border="0" usemap="#include/native/alarm.hdep_map" alt=""></center>
  54 <map name="include/native/alarm.hdep_map">
  55 <area shape="rect" href="ksrc_2skins_2native_2alarm_8c.html" title="This file is part of the Xenomai project." alt="" coords="5,84,184,111"><area shape="rect" href="skins_2native_2module_8c.html" title="This file is part of the Xenomai project." alt="" coords="208,84,397,111"><area shape="rect" href="native_2syscall_8c.html" title="This file is part of the Xenomai project." alt="" coords="421,84,605,111"></map>
  56 </div>
  57
  58 <p>
  59 <a href="alarm_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
  60 <tr><td></td></tr>
  61 <tr><td colspan="2"><br><h2>Functions</h2></td></tr>
  62 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__alarm.html#g22353f79379121bbebfa0e72bbde5028">rt_alarm_create</a> (RT_ALARM *alarm, const char *name, rt_alarm_t handler, void *cookie)</td></tr>
  63
  64 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create an alarm object from kernel space.  <a href="group__alarm.html#g22353f79379121bbebfa0e72bbde5028"></a><br></td></tr>
  65 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__alarm.html#gf00e05b47b1183816480e270d326f9ac">rt_alarm_delete</a> (RT_ALARM *alarm)</td></tr>
  66
  67 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Delete an alarm.  <a href="group__alarm.html#gf00e05b47b1183816480e270d326f9ac"></a><br></td></tr>
  68 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__alarm.html#g0d9cb8ae623be0f7224ac47b10a0b542">rt_alarm_start</a> (RT_ALARM *alarm, RTIME value, RTIME interval)</td></tr>
  69
  70 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Start an alarm.  <a href="group__alarm.html#g0d9cb8ae623be0f7224ac47b10a0b542"></a><br></td></tr>
  71 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__alarm.html#g71f2ffec98e3e23fe5d7f87c2cb24d77">rt_alarm_stop</a> (RT_ALARM *alarm)</td></tr>
  72
  73 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stop an alarm.  <a href="group__alarm.html#g71f2ffec98e3e23fe5d7f87c2cb24d77"></a><br></td></tr>
  74 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__alarm.html#g25c4556b6e2f6fa220a734bf83c4c374">rt_alarm_inquire</a> (RT_ALARM *alarm, RT_ALARM_INFO *info)</td></tr>
  75
  76 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Inquire about an alarm.  <a href="group__alarm.html#g25c4556b6e2f6fa220a734bf83c4c374"></a><br></td></tr>
  77 </table>
  78 </div>
  79 <hr size="1"><address style="text-align: right;"><small>Generated on Tue Mar 8 13:02:05 2011 for Xenomai API by&nbsp;
  80 <a href="http://www.doxygen.org/index.html">
  81 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
  82 </body>
  83 </html>