blob: 9e8b9c7ceb7a48ad7653c1b61e57a584d7884664 [file] [log] [blame] [edit]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>lwIP: src/include/lwip/timeouts.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">lwIP<span id="projectnumber">&#160;2.1.3</span>
</div>
<div id="projectbrief">Lightweight IP stack</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('timeouts_8h.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">timeouts.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="opt_8h.html">lwip/opt.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="err_8h.html">lwip/err.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="sys_8h.html">lwip/sys.h</a>&quot;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlwip__cyclic__timer.html">lwip_cyclic_timer</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a9e2b2593e709ff54c7e3c0b003f6f1b0" id="r_a9e2b2593e709ff54c7e3c0b003f6f1b0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9e2b2593e709ff54c7e3c0b003f6f1b0">SYS_TIMEOUTS_SLEEPTIME_INFINITE</a>&#160;&#160;&#160;0xFFFFFFFF</td></tr>
<tr class="separator:a9e2b2593e709ff54c7e3c0b003f6f1b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a3835d5c43cf31662a2b9c99e72788e25" id="r_a3835d5c43cf31662a2b9c99e72788e25"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3835d5c43cf31662a2b9c99e72788e25">lwip_cyclic_timer_handler</a>) (void)</td></tr>
<tr class="separator:a3835d5c43cf31662a2b9c99e72788e25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d3fe3fbdbddbb9e85f05c85d7181c25" id="r_a1d3fe3fbdbddbb9e85f05c85d7181c25"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1d3fe3fbdbddbb9e85f05c85d7181c25">sys_timeout_handler</a>) (void *arg)</td></tr>
<tr class="separator:a1d3fe3fbdbddbb9e85f05c85d7181c25"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a60f42f167f496f6f740c8df48f4dd26c" id="r_a60f42f167f496f6f740c8df48f4dd26c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a60f42f167f496f6f740c8df48f4dd26c">sys_timeouts_init</a> (void)</td></tr>
<tr class="separator:a60f42f167f496f6f740c8df48f4dd26c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8deed391626ec8b5423998e33782d7a8" id="r_a8deed391626ec8b5423998e33782d7a8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8deed391626ec8b5423998e33782d7a8">sys_timeout</a> (u32_t msecs, <a class="el" href="#a1d3fe3fbdbddbb9e85f05c85d7181c25">sys_timeout_handler</a> handler, void *arg)</td></tr>
<tr class="separator:a8deed391626ec8b5423998e33782d7a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adbfcaa78f4b8d71ae0d7f0bcab6f8fb6" id="r_adbfcaa78f4b8d71ae0d7f0bcab6f8fb6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adbfcaa78f4b8d71ae0d7f0bcab6f8fb6">sys_untimeout</a> (<a class="el" href="#a1d3fe3fbdbddbb9e85f05c85d7181c25">sys_timeout_handler</a> handler, void *arg)</td></tr>
<tr class="separator:adbfcaa78f4b8d71ae0d7f0bcab6f8fb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6913959cf264dbe876b7e7c4db1cc13e" id="r_a6913959cf264dbe876b7e7c4db1cc13e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6913959cf264dbe876b7e7c4db1cc13e">sys_restart_timeouts</a> (void)</td></tr>
<tr class="separator:a6913959cf264dbe876b7e7c4db1cc13e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga83cffdf69ab60fd0eba9d17d363f9883" id="r_ga83cffdf69ab60fd0eba9d17d363f9883"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__lwip__nosys.html#ga83cffdf69ab60fd0eba9d17d363f9883">sys_check_timeouts</a> (void)</td></tr>
<tr class="separator:ga83cffdf69ab60fd0eba9d17d363f9883"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9971a14a5810cfeb1efd7104cde6664" id="r_aa9971a14a5810cfeb1efd7104cde6664"><td class="memItemLeft" align="right" valign="top">u32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa9971a14a5810cfeb1efd7104cde6664">sys_timeouts_sleeptime</a> (void)</td></tr>
<tr class="separator:aa9971a14a5810cfeb1efd7104cde6664"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:addc06ab816f051a0fe6f280972eed142" id="r_addc06ab816f051a0fe6f280972eed142"><td class="memItemLeft" align="right" valign="top">const struct <a class="el" href="structlwip__cyclic__timer.html">lwip_cyclic_timer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#addc06ab816f051a0fe6f280972eed142">lwip_cyclic_timers</a> []</td></tr>
<tr class="separator:addc06ab816f051a0fe6f280972eed142"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d01f287a19f20b073d3a1c306ecbfcd" id="r_a9d01f287a19f20b073d3a1c306ecbfcd"><td class="memItemLeft" align="right" valign="top">const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9d01f287a19f20b073d3a1c306ecbfcd">lwip_num_cyclic_timers</a></td></tr>
<tr class="separator:a9d01f287a19f20b073d3a1c306ecbfcd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Timer implementations </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a9e2b2593e709ff54c7e3c0b003f6f1b0" name="a9e2b2593e709ff54c7e3c0b003f6f1b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e2b2593e709ff54c7e3c0b003f6f1b0">&#9670;&#160;</a></span>SYS_TIMEOUTS_SLEEPTIME_INFINITE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SYS_TIMEOUTS_SLEEPTIME_INFINITE&#160;&#160;&#160;0xFFFFFFFF</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returned by <a class="el" href="#aa9971a14a5810cfeb1efd7104cde6664">sys_timeouts_sleeptime()</a> to indicate there is no timer, so we can sleep forever. </p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a3835d5c43cf31662a2b9c99e72788e25" name="a3835d5c43cf31662a2b9c99e72788e25"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3835d5c43cf31662a2b9c99e72788e25">&#9670;&#160;</a></span>lwip_cyclic_timer_handler</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* lwip_cyclic_timer_handler) (void)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Function prototype for a stack-internal timer function that has to be called at a defined interval </p>
</div>
</div>
<a id="a1d3fe3fbdbddbb9e85f05c85d7181c25" name="a1d3fe3fbdbddbb9e85f05c85d7181c25"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1d3fe3fbdbddbb9e85f05c85d7181c25">&#9670;&#160;</a></span>sys_timeout_handler</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* sys_timeout_handler) (void *arg)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Function prototype for a timeout callback function. Register such a function using <a class="el" href="#a8deed391626ec8b5423998e33782d7a8">sys_timeout()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">arg</td><td>Additional argument to pass to the function - set up by <a class="el" href="#a8deed391626ec8b5423998e33782d7a8">sys_timeout()</a> </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a6913959cf264dbe876b7e7c4db1cc13e" name="a6913959cf264dbe876b7e7c4db1cc13e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6913959cf264dbe876b7e7c4db1cc13e">&#9670;&#160;</a></span>sys_restart_timeouts()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sys_restart_timeouts </td>
<td>(</td>
<td class="paramtype">void</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Rebase the timeout times to the current time. This is necessary if <a class="el" href="group__lwip__nosys.html#ga83cffdf69ab60fd0eba9d17d363f9883">sys_check_timeouts()</a> hasn't been called for a long time (e.g. while saving energy) to prevent all timer functions of that period being called. </p>
</div>
</div>
<a id="a8deed391626ec8b5423998e33782d7a8" name="a8deed391626ec8b5423998e33782d7a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8deed391626ec8b5423998e33782d7a8">&#9670;&#160;</a></span>sys_timeout()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sys_timeout </td>
<td>(</td>
<td class="paramtype">u32_t</td> <td class="paramname"><span class="paramname"><em>msecs</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#a1d3fe3fbdbddbb9e85f05c85d7181c25">sys_timeout_handler</a></td> <td class="paramname"><span class="paramname"><em>handler</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>arg</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a one-shot timer (aka timeout). Timeouts are processed in the following cases:</p><ul>
<li>while waiting for a message using sys_timeouts_mbox_fetch()</li>
<li>by calling <a class="el" href="group__lwip__nosys.html#ga83cffdf69ab60fd0eba9d17d363f9883">sys_check_timeouts()</a> (NO_SYS==1 only)</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">msecs</td><td>time in milliseconds after that the timer should expire </td></tr>
<tr><td class="paramname">handler</td><td>callback function to call when msecs have elapsed </td></tr>
<tr><td class="paramname">arg</td><td>argument to pass to the callback function </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a60f42f167f496f6f740c8df48f4dd26c" name="a60f42f167f496f6f740c8df48f4dd26c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a60f42f167f496f6f740c8df48f4dd26c">&#9670;&#160;</a></span>sys_timeouts_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sys_timeouts_init </td>
<td>(</td>
<td class="paramtype">void</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize this module </p>
</div>
</div>
<a id="aa9971a14a5810cfeb1efd7104cde6664" name="aa9971a14a5810cfeb1efd7104cde6664"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa9971a14a5810cfeb1efd7104cde6664">&#9670;&#160;</a></span>sys_timeouts_sleeptime()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">u32_t sys_timeouts_sleeptime </td>
<td>(</td>
<td class="paramtype">void</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the time left before the next timeout is due. If no timeouts are enqueued, returns 0xffffffff </p>
</div>
</div>
<a id="adbfcaa78f4b8d71ae0d7f0bcab6f8fb6" name="adbfcaa78f4b8d71ae0d7f0bcab6f8fb6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adbfcaa78f4b8d71ae0d7f0bcab6f8fb6">&#9670;&#160;</a></span>sys_untimeout()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sys_untimeout </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a1d3fe3fbdbddbb9e85f05c85d7181c25">sys_timeout_handler</a></td> <td class="paramname"><span class="paramname"><em>handler</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>arg</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Go through timeout list (for this task only) and remove the first matching entry (subsequent entries remain untouched), even though the timeout has not triggered yet.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handler</td><td>callback function that would be called by the timeout </td></tr>
<tr><td class="paramname">arg</td><td>callback argument that would be passed to handler </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="addc06ab816f051a0fe6f280972eed142" name="addc06ab816f051a0fe6f280972eed142"></a>
<h2 class="memtitle"><span class="permalink"><a href="#addc06ab816f051a0fe6f280972eed142">&#9670;&#160;</a></span>lwip_cyclic_timers</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const struct <a class="el" href="structlwip__cyclic__timer.html">lwip_cyclic_timer</a> lwip_cyclic_timers[]</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This array contains all stack-internal cyclic timers. To get the number of timers, use lwip_num_cyclic_timers</p>
<p>This array contains all stack-internal cyclic timers. To get the number of timers, use LWIP_ARRAYSIZE() </p>
</div>
</div>
<a id="a9d01f287a19f20b073d3a1c306ecbfcd" name="a9d01f287a19f20b073d3a1c306ecbfcd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d01f287a19f20b073d3a1c306ecbfcd">&#9670;&#160;</a></span>lwip_num_cyclic_timers</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const int lwip_num_cyclic_timers</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Array size of lwip_cyclic_timers[] </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_b0856f6b0d80ccb263b2f415c91f9e17.html">include</a></li><li class="navelem"><a class="el" href="dir_4e6b3cf33a61b6caac9c8ac30c866f37.html">lwip</a></li><li class="navelem"><a class="el" href="timeouts_8h.html">timeouts.h</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
</ul>
</div>
</body>
</html>