blob: 921141818a4a9715d1f7564fd1a591af42d70a7c [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: IP</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('group__ip.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="#groups">Topics</a> &#124;
<a href="#define-members">Macros</a> </div>
<div class="headertitle"><div class="title">IP<div class="ingroups"><a class="el" href="group__api.html">APIs</a> &raquo; <a class="el" href="group__callbackstyle__api.html">&quot;raw&quot; APIs</a></div></div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="groups" name="groups"></a>
Topics</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ip4.html">IPv4</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ip6.html">IPv6</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:gaf056aa43789c2964f091f8349bb83730" id="r_gaf056aa43789c2964f091f8349bb83730"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gaf056aa43789c2964f091f8349bb83730">ip_output</a>(p, src, dest, ttl, tos, proto)</td></tr>
<tr class="separator:gaf056aa43789c2964f091f8349bb83730"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga51cd772c3f6fca7c0363dca1fce7b250" id="r_ga51cd772c3f6fca7c0363dca1fce7b250"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga51cd772c3f6fca7c0363dca1fce7b250">ip_output_if</a>(p, src, dest, ttl, tos, proto, <a class="el" href="structnetif.html">netif</a>)</td></tr>
<tr class="separator:ga51cd772c3f6fca7c0363dca1fce7b250"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab9d45f846f796bd6ce1e0c780c392765" id="r_gab9d45f846f796bd6ce1e0c780c392765"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gab9d45f846f796bd6ce1e0c780c392765">ip_output_if_src</a>(p, src, dest, ttl, tos, proto, <a class="el" href="structnetif.html">netif</a>)</td></tr>
<tr class="separator:gab9d45f846f796bd6ce1e0c780c392765"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0fa3afc2c00aea346889b476650adee3" id="r_ga0fa3afc2c00aea346889b476650adee3"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga0fa3afc2c00aea346889b476650adee3">ip_route</a>(src, dest)</td></tr>
<tr class="separator:ga0fa3afc2c00aea346889b476650adee3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4a4b9439c91eeec719692dfe10f14af0" id="r_ga4a4b9439c91eeec719692dfe10f14af0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga4a4b9439c91eeec719692dfe10f14af0">ip_netif_get_local_ip</a>(<a class="el" href="structnetif.html">netif</a>, dest)</td></tr>
<tr class="separator:ga4a4b9439c91eeec719692dfe10f14af0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga4a4b9439c91eeec719692dfe10f14af0" name="ga4a4b9439c91eeec719692dfe10f14af0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4a4b9439c91eeec719692dfe10f14af0">&#9670;&#160;</a></span>ip_netif_get_local_ip</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ip_netif_get_local_ip</td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em><a class="el" href="structnetif.html">netif</a></em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>dest</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> (IP_IS_V6(dest) ? \</div>
<div class="line"> ip6_netif_get_local_ip(<a class="code hl_struct" href="structnetif.html">netif</a>, <a class="code hl_define" href="group__ip6addr.html#ga06e75bcd198012b5ba39480c233608bd">ip_2_ip6</a>(dest)) : \</div>
<div class="line"> ip4_netif_get_local_ip(<a class="code hl_struct" href="structnetif.html">netif</a>))</div>
<div class="ttc" id="agroup__ip6addr_html_ga06e75bcd198012b5ba39480c233608bd"><div class="ttname"><a href="group__ip6addr.html#ga06e75bcd198012b5ba39480c233608bd">ip_2_ip6</a></div><div class="ttdeci">#define ip_2_ip6(ipaddr)</div><div class="ttdef"><b>Definition</b> ip_addr.h:116</div></div>
<div class="ttc" id="astructnetif_html"><div class="ttname"><a href="structnetif.html">netif</a></div><div class="ttdef"><b>Definition</b> netif.h:260</div></div>
</div><!-- fragment --><p>Get netif for IP. </p>
</div>
</div>
<a id="gaf056aa43789c2964f091f8349bb83730" name="gaf056aa43789c2964f091f8349bb83730"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf056aa43789c2964f091f8349bb83730">&#9670;&#160;</a></span>ip_output</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ip_output</td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>p</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>src</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>dest</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>ttl</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>tos</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>proto</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> (IP_IS_V6(dest) ? \</div>
<div class="line"> ip6_output(p, <a class="code hl_define" href="group__ip6addr.html#ga06e75bcd198012b5ba39480c233608bd">ip_2_ip6</a>(src), <a class="code hl_define" href="group__ip6addr.html#ga06e75bcd198012b5ba39480c233608bd">ip_2_ip6</a>(dest), ttl, tos, proto) : \</div>
<div class="line"> <a class="code hl_function" href="ip4_8c.html#ac87d296205eb5ac04058e609672d4ba8">ip4_output</a>(p, <a class="code hl_define" href="group__ip4addr.html#gad7268a496b7e3f872efecd859eba6f03">ip_2_ip4</a>(src), <a class="code hl_define" href="group__ip4addr.html#gad7268a496b7e3f872efecd859eba6f03">ip_2_ip4</a>(dest), ttl, tos, proto))</div>
<div class="ttc" id="agroup__ip4addr_html_gad7268a496b7e3f872efecd859eba6f03"><div class="ttname"><a href="group__ip4addr.html#gad7268a496b7e3f872efecd859eba6f03">ip_2_ip4</a></div><div class="ttdeci">#define ip_2_ip4(ipaddr)</div><div class="ttdef"><b>Definition</b> ip_addr.h:120</div></div>
<div class="ttc" id="aip4_8c_html_ac87d296205eb5ac04058e609672d4ba8"><div class="ttname"><a href="ip4_8c.html#ac87d296205eb5ac04058e609672d4ba8">ip4_output</a></div><div class="ttdeci">err_t ip4_output(struct pbuf *p, const ip4_addr_t *src, const ip4_addr_t *dest, u8_t ttl, u8_t tos, u8_t proto)</div><div class="ttdef"><b>Definition</b> ip4.c:1028</div></div>
</div><!-- fragment --><p>Output IP packet, netif is selected by source address </p>
</div>
</div>
<a id="ga51cd772c3f6fca7c0363dca1fce7b250" name="ga51cd772c3f6fca7c0363dca1fce7b250"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga51cd772c3f6fca7c0363dca1fce7b250">&#9670;&#160;</a></span>ip_output_if</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ip_output_if</td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>p</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>src</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>dest</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>ttl</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>tos</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>proto</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em><a class="el" href="structnetif.html">netif</a></em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> (IP_IS_V6(dest) ? \</div>
<div class="line"> ip6_output_if(p, <a class="code hl_define" href="group__ip6addr.html#ga06e75bcd198012b5ba39480c233608bd">ip_2_ip6</a>(src), <a class="code hl_define" href="group__ip6addr.html#ga06e75bcd198012b5ba39480c233608bd">ip_2_ip6</a>(dest), ttl, tos, proto, <a class="code hl_struct" href="structnetif.html">netif</a>) : \</div>
<div class="line"> <a class="code hl_function" href="ip4_8c.html#ab220bc4ce4f48bdbba447358b3594917">ip4_output_if</a>(p, <a class="code hl_define" href="group__ip4addr.html#gad7268a496b7e3f872efecd859eba6f03">ip_2_ip4</a>(src), <a class="code hl_define" href="group__ip4addr.html#gad7268a496b7e3f872efecd859eba6f03">ip_2_ip4</a>(dest), ttl, tos, proto, <a class="code hl_struct" href="structnetif.html">netif</a>))</div>
<div class="ttc" id="aip4_8c_html_ab220bc4ce4f48bdbba447358b3594917"><div class="ttname"><a href="ip4_8c.html#ab220bc4ce4f48bdbba447358b3594917">ip4_output_if</a></div><div class="ttdeci">err_t ip4_output_if(struct pbuf *p, const ip4_addr_t *src, const ip4_addr_t *dest, u8_t ttl, u8_t tos, u8_t proto, struct netif *netif)</div><div class="ttdef"><b>Definition</b> ip4.c:787</div></div>
</div><!-- fragment --><p>Output IP packet to specified interface </p>
</div>
</div>
<a id="gab9d45f846f796bd6ce1e0c780c392765" name="gab9d45f846f796bd6ce1e0c780c392765"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab9d45f846f796bd6ce1e0c780c392765">&#9670;&#160;</a></span>ip_output_if_src</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ip_output_if_src</td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>p</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>src</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>dest</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>ttl</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>tos</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>proto</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em><a class="el" href="structnetif.html">netif</a></em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> (IP_IS_V6(dest) ? \</div>
<div class="line"> ip6_output_if_src(p, <a class="code hl_define" href="group__ip6addr.html#ga06e75bcd198012b5ba39480c233608bd">ip_2_ip6</a>(src), <a class="code hl_define" href="group__ip6addr.html#ga06e75bcd198012b5ba39480c233608bd">ip_2_ip6</a>(dest), ttl, tos, proto, <a class="code hl_struct" href="structnetif.html">netif</a>) : \</div>
<div class="line"> <a class="code hl_function" href="ip4_8c.html#a2943d118873e9eb1d8296e04a6740db7">ip4_output_if_src</a>(p, <a class="code hl_define" href="group__ip4addr.html#gad7268a496b7e3f872efecd859eba6f03">ip_2_ip4</a>(src), <a class="code hl_define" href="group__ip4addr.html#gad7268a496b7e3f872efecd859eba6f03">ip_2_ip4</a>(dest), ttl, tos, proto, <a class="code hl_struct" href="structnetif.html">netif</a>))</div>
<div class="ttc" id="aip4_8c_html_a2943d118873e9eb1d8296e04a6740db7"><div class="ttname"><a href="ip4_8c.html#a2943d118873e9eb1d8296e04a6740db7">ip4_output_if_src</a></div><div class="ttdeci">err_t ip4_output_if_src(struct pbuf *p, const ip4_addr_t *src, const ip4_addr_t *dest, u8_t ttl, u8_t tos, u8_t proto, struct netif *netif)</div><div class="ttdef"><b>Definition</b> ip4.c:827</div></div>
</div><!-- fragment --><p>Output IP packet to interface specifying source address </p>
</div>
</div>
<a id="ga0fa3afc2c00aea346889b476650adee3" name="ga0fa3afc2c00aea346889b476650adee3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0fa3afc2c00aea346889b476650adee3">&#9670;&#160;</a></span>ip_route</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ip_route</td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>src</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>dest</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> (IP_IS_V6(dest) ? \</div>
<div class="line"> ip6_route(<a class="code hl_define" href="group__ip6addr.html#ga06e75bcd198012b5ba39480c233608bd">ip_2_ip6</a>(src), <a class="code hl_define" href="group__ip6addr.html#ga06e75bcd198012b5ba39480c233608bd">ip_2_ip6</a>(dest)) : \</div>
<div class="line"> <a class="code hl_function" href="ip4_8c.html#ac04e6e67e8f0aff18dd4cf8a2439f56e">ip4_route_src</a>(<a class="code hl_define" href="group__ip4addr.html#gad7268a496b7e3f872efecd859eba6f03">ip_2_ip4</a>(src), <a class="code hl_define" href="group__ip4addr.html#gad7268a496b7e3f872efecd859eba6f03">ip_2_ip4</a>(dest)))</div>
<div class="ttc" id="aip4_8c_html_ac04e6e67e8f0aff18dd4cf8a2439f56e"><div class="ttname"><a href="ip4_8c.html#ac04e6e67e8f0aff18dd4cf8a2439f56e">ip4_route_src</a></div><div class="ttdeci">struct netif * ip4_route_src(const ip4_addr_t *src, const ip4_addr_t *dest)</div><div class="ttdef"><b>Definition</b> ip4.c:129</div></div>
</div><!-- fragment --><p>Get netif for address combination. See <a class="el" href="ip6_8c.html#a519686a2c3beb689bf1d3380c4e5efb1">ip6_route</a> and <a class="el" href="ip4_8c.html#a5bbbec93cef9133ed07d8c2cd9bc80f3">ip4_route</a> </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="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>