242 lines
15 KiB
HTML
242 lines
15 KiB
HTML
<!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">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.20"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>lwIP: src/include/lwip/acd.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>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.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 style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">lwIP
|
|
 <span id="projectnumber">2.2.1</span>
|
|
</div>
|
|
<div id="projectbrief">Lightweight IP stack</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.20 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('acd_8h.html',''); initResizable(); });
|
|
/* @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">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Data Structures</a> |
|
|
<a href="#define-members">Macros</a> |
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">acd.h File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><code>#include "<a class="el" href="opt_8h.html">lwip/opt.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="netif_8h.html">lwip/netif.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="lwip_2etharp_8h.html">lwip/etharp.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="prot_2acd_8h.html">lwip/prot/acd.h</a>"</code><br />
|
|
</div><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structacd.html">acd</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:aace6da0b0dacd77a9d6bd11f424ffa82"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="acd_8h.html#aace6da0b0dacd77a9d6bd11f424ffa82">ACD_TMR_INTERVAL</a>   100</td></tr>
|
|
<tr class="separator:aace6da0b0dacd77a9d6bd11f424ffa82"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:abb446404752f56b028eafa8302db955f"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="acd_8h.html#abb446404752f56b028eafa8302db955f">acd_conflict_callback_t</a>) (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>, acd_callback_enum_t state)</td></tr>
|
|
<tr class="separator:abb446404752f56b028eafa8302db955f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ga158856bf139cb2761837ddfa07303bdc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__acd.html#ga158856bf139cb2761837ddfa07303bdc">acd_add</a> (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>, struct <a class="el" href="structacd.html">acd</a> *<a class="el" href="structacd.html">acd</a>, <a class="el" href="acd_8h.html#abb446404752f56b028eafa8302db955f">acd_conflict_callback_t</a> acd_conflict_callback)</td></tr>
|
|
<tr class="separator:ga158856bf139cb2761837ddfa07303bdc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga70503696bca25e1cfb61fad38b4327da"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__acd.html#ga70503696bca25e1cfb61fad38b4327da">acd_remove</a> (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>, struct <a class="el" href="structacd.html">acd</a> *<a class="el" href="structacd.html">acd</a>)</td></tr>
|
|
<tr class="separator:ga70503696bca25e1cfb61fad38b4327da"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga2ca2e2dbb9713f90515d443dc691b5cb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__acd.html#ga2ca2e2dbb9713f90515d443dc691b5cb">acd_start</a> (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>, struct <a class="el" href="structacd.html">acd</a> *<a class="el" href="structacd.html">acd</a>, <a class="el" href="ip4__addr_8h.html#a3d3b45daffbc15d65da236e31e621b7e">ip4_addr_t</a> ipaddr)</td></tr>
|
|
<tr class="separator:ga2ca2e2dbb9713f90515d443dc691b5cb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga36da2b23951a14ca3c92f5e78db2f1b7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__acd.html#ga36da2b23951a14ca3c92f5e78db2f1b7">acd_stop</a> (struct <a class="el" href="structacd.html">acd</a> *<a class="el" href="structacd.html">acd</a>)</td></tr>
|
|
<tr class="separator:ga36da2b23951a14ca3c92f5e78db2f1b7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa92e21410d0f0d357ab9166cda24937a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="acd_8h.html#aa92e21410d0f0d357ab9166cda24937a">acd_arp_reply</a> (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>, struct <a class="el" href="structetharp__hdr.html">etharp_hdr</a> *hdr)</td></tr>
|
|
<tr class="separator:aa92e21410d0f0d357ab9166cda24937a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8ddf3e1cfa8f5d674d6ce00c2f7d841e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="acd_8h.html#a8ddf3e1cfa8f5d674d6ce00c2f7d841e">acd_tmr</a> (void)</td></tr>
|
|
<tr class="separator:a8ddf3e1cfa8f5d674d6ce00c2f7d841e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga2872fa375f9cd8f5b095639d652f6bff"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__acd.html#ga2872fa375f9cd8f5b095639d652f6bff">acd_network_changed_link_down</a> (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>)</td></tr>
|
|
<tr class="separator:ga2872fa375f9cd8f5b095639d652f6bff"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga18b444f6fc69325416b463208a754c97"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__acd.html#ga18b444f6fc69325416b463208a754c97">acd_netif_ip_addr_changed</a> (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>, const <a class="el" href="group__ipaddr.html#ga335a8c9df66319e88a1a529047ce0a1e">ip_addr_t</a> *old_addr, const <a class="el" href="group__ipaddr.html#ga335a8c9df66319e88a1a529047ce0a1e">ip_addr_t</a> *new_addr)</td></tr>
|
|
<tr class="separator:ga18b444f6fc69325416b463208a754c97"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>ACD IPv4 Address Conflict Detection </p>
|
|
</div><h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a id="aace6da0b0dacd77a9d6bd11f424ffa82"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aace6da0b0dacd77a9d6bd11f424ffa82">◆ </a></span>ACD_TMR_INTERVAL</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define ACD_TMR_INTERVAL   100</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>ACD Timing ACD_TMR_INTERVAL msecs, I recommend a value of 100. The value must divide 1000 with a remainder almost 0. Possible values are 1000, 500, 333, 250, 200, 166, 142, 125, 111, 100 .... </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Typedef Documentation</h2>
|
|
<a id="abb446404752f56b028eafa8302db955f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abb446404752f56b028eafa8302db955f">◆ </a></span>acd_conflict_callback_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef void(* acd_conflict_callback_t) (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>, acd_callback_enum_t state)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Callback function: Handle conflict information from ACD module</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">netif</td><td>network interface to handle conflict information on </td></tr>
|
|
<tr><td class="paramname">state</td><td>acd_callback_enum_t </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="aa92e21410d0f0d357ab9166cda24937a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa92e21410d0f0d357ab9166cda24937a">◆ </a></span>acd_arp_reply()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void acd_arp_reply </td>
|
|
<td>(</td>
|
|
<td class="paramtype">struct <a class="el" href="structnetif.html">netif</a> * </td>
|
|
<td class="paramname"><em>netif</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">struct <a class="el" href="structetharp__hdr.html">etharp_hdr</a> * </td>
|
|
<td class="paramname"><em>hdr</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Handles every incoming ARP Packet, called by <a class="el" href="etharp_8c.html#a540a5506979693ef9ac4496db9bfa7d6">etharp_input()</a>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">netif</td><td>network interface to use for acd processing </td></tr>
|
|
<tr><td class="paramname">hdr</td><td>Incoming ARP packet </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8ddf3e1cfa8f5d674d6ce00c2f7d841e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8ddf3e1cfa8f5d674d6ce00c2f7d841e">◆ </a></span>acd_tmr()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void acd_tmr </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Has to be called in loop every ACD_TMR_INTERVAL milliseconds </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="acd_8h.html">acd.h</a></li>
|
|
<li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|