blob: 3b0328d7c384e5959bfdc1703fdead1d907fb106 [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/priv/raw_priv.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('raw__priv_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="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">raw_priv.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="raw_8h.html">lwip/raw.h</a>&quot;</code><br />
</div><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:a50dd44a4fb984a1975e15dd073d34e8d" id="r_a50dd44a4fb984a1975e15dd073d34e8d"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="#a2580ec946c4196127888d5405257866b">raw_input_state</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a50dd44a4fb984a1975e15dd073d34e8d">raw_input_state_t</a></td></tr>
<tr class="separator:a50dd44a4fb984a1975e15dd073d34e8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a2580ec946c4196127888d5405257866b" id="r_a2580ec946c4196127888d5405257866b"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2580ec946c4196127888d5405257866b">raw_input_state</a> </td></tr>
<tr class="separator:a2580ec946c4196127888d5405257866b"><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:a03c4582d9ecf687e1f31d597c7889553" id="r_a03c4582d9ecf687e1f31d597c7889553"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a50dd44a4fb984a1975e15dd073d34e8d">raw_input_state_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a03c4582d9ecf687e1f31d597c7889553">raw_input</a> (struct <a class="el" href="structpbuf.html">pbuf</a> *p, struct <a class="el" href="structnetif.html">netif</a> *inp)</td></tr>
<tr class="separator:a03c4582d9ecf687e1f31d597c7889553"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61dc42f18e34800643000e48be6543ab" id="r_a61dc42f18e34800643000e48be6543ab"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a61dc42f18e34800643000e48be6543ab">raw_netif_ip_addr_changed</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:a61dc42f18e34800643000e48be6543ab"><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>raw API internal implementations (do not use in application code) </p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="a50dd44a4fb984a1975e15dd073d34e8d" name="a50dd44a4fb984a1975e15dd073d34e8d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a50dd44a4fb984a1975e15dd073d34e8d">&#9670;&#160;</a></span>raw_input_state_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="#a2580ec946c4196127888d5405257866b">raw_input_state</a> <a class="el" href="#a50dd44a4fb984a1975e15dd073d34e8d">raw_input_state_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>return codes for raw_input </p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a2580ec946c4196127888d5405257866b" name="a2580ec946c4196127888d5405257866b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2580ec946c4196127888d5405257866b">&#9670;&#160;</a></span>raw_input_state</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="#a2580ec946c4196127888d5405257866b">raw_input_state</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>return codes for raw_input </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a03c4582d9ecf687e1f31d597c7889553" name="a03c4582d9ecf687e1f31d597c7889553"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03c4582d9ecf687e1f31d597c7889553">&#9670;&#160;</a></span>raw_input()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="#a50dd44a4fb984a1975e15dd073d34e8d">raw_input_state_t</a> raw_input </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structpbuf.html">pbuf</a> *</td> <td class="paramname"><span class="paramname"><em>p</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structnetif.html">netif</a> *</td> <td class="paramname"><span class="paramname"><em>inp</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Determine if in incoming IP packet is covered by a RAW PCB and if so, pass it to a user-provided receive callback function.</p>
<p>Given an incoming IP datagram (as a chain of pbufs) this function finds a corresponding RAW PCB and calls the corresponding receive callback function.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>pbuf to be demultiplexed to a RAW PCB. </td></tr>
<tr><td class="paramname">inp</td><td>network interface on which the datagram was received. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>- 1 if the packet has been eaten by a RAW PCB receive callback function. The caller MAY NOT not reference the packet any longer, and MAY NOT call <a class="el" href="group__pbuf.html#gab0dd696fb4b6bc65e548944584f1738b">pbuf_free()</a>. </dd>
<dd>
- 0 if packet is not eaten (pbuf is still referenced by the caller). </dd></dl>
</div>
</div>
<a id="a61dc42f18e34800643000e48be6543ab" name="a61dc42f18e34800643000e48be6543ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a61dc42f18e34800643000e48be6543ab">&#9670;&#160;</a></span>raw_netif_ip_addr_changed()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void raw_netif_ip_addr_changed </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__ipaddr.html#ga335a8c9df66319e88a1a529047ce0a1e">ip_addr_t</a> *</td> <td class="paramname"><span class="paramname"><em>old_addr</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__ipaddr.html#ga335a8c9df66319e88a1a529047ce0a1e">ip_addr_t</a> *</td> <td class="paramname"><span class="paramname"><em>new_addr</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>This function is called from <a class="el" href="netif_8c.html">netif.c</a> when address is changed</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">old_addr</td><td>IP address of the netif before change </td></tr>
<tr><td class="paramname">new_addr</td><td>IP address of the netif after change </td></tr>
</table>
</dd>
</dl>
</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="dir_460c501b2432fc107adcb38111835e48.html">priv</a></li><li class="navelem"><a class="el" href="raw__priv_8h.html">raw_priv.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>