blob: 0237efd07f6f3db2109bfef45a4dfc2f5ebe807a [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: IPv4 address handling</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__netif__ip4.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="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">IPv4 address handling<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> &raquo; <a class="el" href="group__netif.html">Network interface (NETIF)</a></div></div></div>
</div><!--header-->
<div class="contents">
<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:ga73b043a7ec0e4899aba8433ec9064cca" id="r_ga73b043a7ec0e4899aba8433ec9064cca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga73b043a7ec0e4899aba8433ec9064cca">netif_set_ipaddr</a> (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>, const <a class="el" href="ip4__addr_8h.html#a3d3b45daffbc15d65da236e31e621b7e">ip4_addr_t</a> *ipaddr)</td></tr>
<tr class="separator:ga73b043a7ec0e4899aba8433ec9064cca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0bdd7c057c2f55f670853e3906014a53" id="r_ga0bdd7c057c2f55f670853e3906014a53"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga0bdd7c057c2f55f670853e3906014a53">netif_set_netmask</a> (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>, const <a class="el" href="ip4__addr_8h.html#a3d3b45daffbc15d65da236e31e621b7e">ip4_addr_t</a> *netmask)</td></tr>
<tr class="separator:ga0bdd7c057c2f55f670853e3906014a53"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga841876c274c3c90898579f9e12f3b520" id="r_ga841876c274c3c90898579f9e12f3b520"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga841876c274c3c90898579f9e12f3b520">netif_set_gw</a> (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>, const <a class="el" href="ip4__addr_8h.html#a3d3b45daffbc15d65da236e31e621b7e">ip4_addr_t</a> *gw)</td></tr>
<tr class="separator:ga841876c274c3c90898579f9e12f3b520"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga85e31a68e96390dab2feffb11f4948a1" id="r_ga85e31a68e96390dab2feffb11f4948a1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga85e31a68e96390dab2feffb11f4948a1">netif_set_addr</a> (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>, const <a class="el" href="ip4__addr_8h.html#a3d3b45daffbc15d65da236e31e621b7e">ip4_addr_t</a> *ipaddr, const <a class="el" href="ip4__addr_8h.html#a3d3b45daffbc15d65da236e31e621b7e">ip4_addr_t</a> *netmask, const <a class="el" href="ip4__addr_8h.html#a3d3b45daffbc15d65da236e31e621b7e">ip4_addr_t</a> *gw)</td></tr>
<tr class="separator:ga85e31a68e96390dab2feffb11f4948a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga85e31a68e96390dab2feffb11f4948a1" name="ga85e31a68e96390dab2feffb11f4948a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga85e31a68e96390dab2feffb11f4948a1">&#9670;&#160;</a></span>netif_set_addr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void netif_set_addr </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structnetif.html">netif</a> *</td> <td class="paramname"><span class="paramname"><em>netif</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="ip4__addr_8h.html#a3d3b45daffbc15d65da236e31e621b7e">ip4_addr_t</a> *</td> <td class="paramname"><span class="paramname"><em>ipaddr</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="ip4__addr_8h.html#a3d3b45daffbc15d65da236e31e621b7e">ip4_addr_t</a> *</td> <td class="paramname"><span class="paramname"><em>netmask</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="ip4__addr_8h.html#a3d3b45daffbc15d65da236e31e621b7e">ip4_addr_t</a> *</td> <td class="paramname"><span class="paramname"><em>gw</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Change IP address configuration for a network interface (including netmask and default gateway).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">netif</td><td>the network interface to change </td></tr>
<tr><td class="paramname">ipaddr</td><td>the new IP address </td></tr>
<tr><td class="paramname">netmask</td><td>the new netmask </td></tr>
<tr><td class="paramname">gw</td><td>the new default gateway </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga841876c274c3c90898579f9e12f3b520" name="ga841876c274c3c90898579f9e12f3b520"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga841876c274c3c90898579f9e12f3b520">&#9670;&#160;</a></span>netif_set_gw()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void netif_set_gw </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structnetif.html">netif</a> *</td> <td class="paramname"><span class="paramname"><em>netif</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="ip4__addr_8h.html#a3d3b45daffbc15d65da236e31e621b7e">ip4_addr_t</a> *</td> <td class="paramname"><span class="paramname"><em>gw</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Change the default gateway for a network interface</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">netif</td><td>the network interface to change </td></tr>
<tr><td class="paramname">gw</td><td>the new default gateway</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>call <a class="el" href="#ga85e31a68e96390dab2feffb11f4948a1">netif_set_addr()</a> if you also want to change ip address and netmask </dd></dl>
</div>
</div>
<a id="ga73b043a7ec0e4899aba8433ec9064cca" name="ga73b043a7ec0e4899aba8433ec9064cca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga73b043a7ec0e4899aba8433ec9064cca">&#9670;&#160;</a></span>netif_set_ipaddr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void netif_set_ipaddr </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structnetif.html">netif</a> *</td> <td class="paramname"><span class="paramname"><em>netif</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="ip4__addr_8h.html#a3d3b45daffbc15d65da236e31e621b7e">ip4_addr_t</a> *</td> <td class="paramname"><span class="paramname"><em>ipaddr</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Change the IP address of a network interface</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">netif</td><td>the network interface to change </td></tr>
<tr><td class="paramname">ipaddr</td><td>the new IP address</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>call <a class="el" href="#ga85e31a68e96390dab2feffb11f4948a1">netif_set_addr()</a> if you also want to change netmask and default gateway </dd></dl>
</div>
</div>
<a id="ga0bdd7c057c2f55f670853e3906014a53" name="ga0bdd7c057c2f55f670853e3906014a53"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0bdd7c057c2f55f670853e3906014a53">&#9670;&#160;</a></span>netif_set_netmask()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void netif_set_netmask </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structnetif.html">netif</a> *</td> <td class="paramname"><span class="paramname"><em>netif</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="ip4__addr_8h.html#a3d3b45daffbc15d65da236e31e621b7e">ip4_addr_t</a> *</td> <td class="paramname"><span class="paramname"><em>netmask</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Change the netmask of a network interface</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">netif</td><td>the network interface to change </td></tr>
<tr><td class="paramname">netmask</td><td>the new netmask</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>call <a class="el" href="#ga85e31a68e96390dab2feffb11f4948a1">netif_set_addr()</a> if you also want to change ip address and default gateway </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="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>