Google Git
Sign in
pigweed / third_party / github / STMicroelectronics / stm32_mw_lwip / refs/heads/main / . / doc / doxygen / output / html / lwip_2inet_8h.html
blob: 3e337553fed826ef8e0b4378cebdab808ddc1a84 [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/inet.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('lwip_2inet_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="#define-members">Macros</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">inet.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="def_8h.html">lwip/def.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="ip__addr_8h.html">lwip/ip_addr.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="ip6__addr_8h.html">lwip/ip6_addr.h</a>&quot;</code><br />
</div><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:a3d2472d6cf31b73eeb829110dd0fffea" id="r_a3d2472d6cf31b73eeb829110dd0fffea"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3d2472d6cf31b73eeb829110dd0fffea">INADDR_NONE</a>&#160;&#160;&#160;<a class="el" href="ip4__addr_8h.html#abc4b2e3531c4992f2ae4b8c0f9751544">IPADDR_NONE</a></td></tr>
<tr class="separator:a3d2472d6cf31b73eeb829110dd0fffea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1ac25d7797666cff6d01d6c795c2378" id="r_ae1ac25d7797666cff6d01d6c795c2378"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae1ac25d7797666cff6d01d6c795c2378">INADDR_LOOPBACK</a>&#160;&#160;&#160;<a class="el" href="ip4__addr_8h.html#a6f51a2eb21547df4e6b3ba046188345e">IPADDR_LOOPBACK</a></td></tr>
<tr class="separator:ae1ac25d7797666cff6d01d6c795c2378"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5d1940045dc2e7de552f3d4ff13a74ab" id="r_a5d1940045dc2e7de552f3d4ff13a74ab"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5d1940045dc2e7de552f3d4ff13a74ab">INADDR_ANY</a>&#160;&#160;&#160;<a class="el" href="ip4__addr_8h.html#ad6ed0d622d61ecd6edd606e3b564f0a2">IPADDR_ANY</a></td></tr>
<tr class="separator:a5d1940045dc2e7de552f3d4ff13a74ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a725f61ded23ce8a7dff8e82ed51986" id="r_a4a725f61ded23ce8a7dff8e82ed51986"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4a725f61ded23ce8a7dff8e82ed51986">INADDR_BROADCAST</a>&#160;&#160;&#160;<a class="el" href="ip4__addr_8h.html#ac661fca7e7d25e5cd379b811a767c29a">IPADDR_BROADCAST</a></td></tr>
<tr class="separator:a4a725f61ded23ce8a7dff8e82ed51986"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1de876a356ee05a2e9427b741f99f49c" id="r_a1de876a356ee05a2e9427b741f99f49c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1de876a356ee05a2e9427b741f99f49c">IN6ADDR_ANY_INIT</a>&#160;&#160;&#160;{{{0,0,0,0}}}</td></tr>
<tr class="separator:a1de876a356ee05a2e9427b741f99f49c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5562c81af19ee5988ddc5a5c6153cf37" id="r_a5562c81af19ee5988ddc5a5c6153cf37"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5562c81af19ee5988ddc5a5c6153cf37">IN6ADDR_LOOPBACK_INIT</a>&#160;&#160;&#160;{{{0,0,0,PP_HTONL(1)}}}</td></tr>
<tr class="separator:a5562c81af19ee5988ddc5a5c6153cf37"><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:af8c97553060738d9edd6bfeab13ef7c3" id="r_af8c97553060738d9edd6bfeab13ef7c3"><td class="memItemLeft" align="right" valign="top">const struct in6_addr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af8c97553060738d9edd6bfeab13ef7c3">in6addr_any</a></td></tr>
<tr class="separator:af8c97553060738d9edd6bfeab13ef7c3"><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>This file (together with <a class="el" href="sockets_8h.html">sockets.h</a>) aims to provide structs and functions from</p><ul>
<li><a class="el" href="compat_2posix_2arpa_2inet_8h.html">arpa/inet.h</a></li>
<li>netinet/in.h </li>
</ul>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a1de876a356ee05a2e9427b741f99f49c" name="a1de876a356ee05a2e9427b741f99f49c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1de876a356ee05a2e9427b741f99f49c">&#9670;&#160;</a></span>IN6ADDR_ANY_INIT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define IN6ADDR_ANY_INIT&#160;&#160;&#160;{{{0,0,0,0}}}</td>
</tr>
</table>
</div><div class="memdoc">
<p>This macro can be used to initialize a variable of type struct in6_addr to the IPv6 wildcard address. </p>
</div>
</div>
<a id="a5562c81af19ee5988ddc5a5c6153cf37" name="a5562c81af19ee5988ddc5a5c6153cf37"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5562c81af19ee5988ddc5a5c6153cf37">&#9670;&#160;</a></span>IN6ADDR_LOOPBACK_INIT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define IN6ADDR_LOOPBACK_INIT&#160;&#160;&#160;{{{0,0,0,PP_HTONL(1)}}}</td>
</tr>
</table>
</div><div class="memdoc">
<p>This macro can be used to initialize a variable of type struct in6_addr to the IPv6 loopback address. </p>
</div>
</div>
<a id="a5d1940045dc2e7de552f3d4ff13a74ab" name="a5d1940045dc2e7de552f3d4ff13a74ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5d1940045dc2e7de552f3d4ff13a74ab">&#9670;&#160;</a></span>INADDR_ANY</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define INADDR_ANY&#160;&#160;&#160;<a class="el" href="ip4__addr_8h.html#ad6ed0d622d61ecd6edd606e3b564f0a2">IPADDR_ANY</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>0.0.0.0 </p>
</div>
</div>
<a id="a4a725f61ded23ce8a7dff8e82ed51986" name="a4a725f61ded23ce8a7dff8e82ed51986"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a725f61ded23ce8a7dff8e82ed51986">&#9670;&#160;</a></span>INADDR_BROADCAST</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define INADDR_BROADCAST&#160;&#160;&#160;<a class="el" href="ip4__addr_8h.html#ac661fca7e7d25e5cd379b811a767c29a">IPADDR_BROADCAST</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>255.255.255.255 </p>
</div>
</div>
<a id="ae1ac25d7797666cff6d01d6c795c2378" name="ae1ac25d7797666cff6d01d6c795c2378"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae1ac25d7797666cff6d01d6c795c2378">&#9670;&#160;</a></span>INADDR_LOOPBACK</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define INADDR_LOOPBACK&#160;&#160;&#160;<a class="el" href="ip4__addr_8h.html#a6f51a2eb21547df4e6b3ba046188345e">IPADDR_LOOPBACK</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>127.0.0.1 </p>
</div>
</div>
<a id="a3d2472d6cf31b73eeb829110dd0fffea" name="a3d2472d6cf31b73eeb829110dd0fffea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d2472d6cf31b73eeb829110dd0fffea">&#9670;&#160;</a></span>INADDR_NONE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define INADDR_NONE&#160;&#160;&#160;<a class="el" href="ip4__addr_8h.html#abc4b2e3531c4992f2ae4b8c0f9751544">IPADDR_NONE</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>255.255.255.255 </p>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="af8c97553060738d9edd6bfeab13ef7c3" name="af8c97553060738d9edd6bfeab13ef7c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af8c97553060738d9edd6bfeab13ef7c3">&#9670;&#160;</a></span>in6addr_any</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const struct in6_addr in6addr_any</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 variable is initialized by the system to contain the wildcard IPv6 address. </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="lwip_2inet_8h.html">inet.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>