blob: 78d576900c69111badf61308ce218a0d429e4a00 [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: IPv6 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__ip6.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">IPv6 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:gae21572fdbd8664d22a1b281a6c31c9bb" id="r_gae21572fdbd8664d22a1b281a6c31c9bb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gae21572fdbd8664d22a1b281a6c31c9bb">netif_ip6_addr_set</a> (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>, s8_t addr_idx, const <a class="el" href="ip6__addr_8h.html#aaca9e796e93a355294c4954c08d01762">ip6_addr_t</a> *addr6)</td></tr>
<tr class="separator:gae21572fdbd8664d22a1b281a6c31c9bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9cde7286535c7f037a9b16052561b91f" id="r_ga9cde7286535c7f037a9b16052561b91f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga9cde7286535c7f037a9b16052561b91f">netif_ip6_addr_set_state</a> (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>, s8_t addr_idx, u8_t state)</td></tr>
<tr class="separator:ga9cde7286535c7f037a9b16052561b91f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae864211a5eb052deb5da7bc7e3427fb9" id="r_gae864211a5eb052deb5da7bc7e3427fb9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gae864211a5eb052deb5da7bc7e3427fb9">netif_create_ip6_linklocal_address</a> (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>, u8_t from_mac_48bit)</td></tr>
<tr class="separator:gae864211a5eb052deb5da7bc7e3427fb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab0727fba5f5b3fed8d7013775506f327" id="r_gab0727fba5f5b3fed8d7013775506f327"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gab0727fba5f5b3fed8d7013775506f327">netif_add_ip6_address</a> (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>, const <a class="el" href="ip6__addr_8h.html#aaca9e796e93a355294c4954c08d01762">ip6_addr_t</a> *ip6addr, s8_t *chosen_idx)</td></tr>
<tr class="separator:gab0727fba5f5b3fed8d7013775506f327"><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="gab0727fba5f5b3fed8d7013775506f327" name="gab0727fba5f5b3fed8d7013775506f327"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab0727fba5f5b3fed8d7013775506f327">&#9670;&#160;</a></span>netif_add_ip6_address()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a> netif_add_ip6_address </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="ip6__addr_8h.html#aaca9e796e93a355294c4954c08d01762">ip6_addr_t</a> *</td> <td class="paramname"><span class="paramname"><em>ip6addr</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">s8_t *</td> <td class="paramname"><span class="paramname"><em>chosen_idx</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>This function allows for the easy addition of a new IPv6 address to an interface. It takes care of finding an empty slot and then sets the address tentative (to make sure that all the subsequent processing happens).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">netif</td><td>netif to add the address on </td></tr>
<tr><td class="paramname">ip6addr</td><td>address to add </td></tr>
<tr><td class="paramname">chosen_idx</td><td>if != NULL, the chosen IPv6 address index will be stored here </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gae864211a5eb052deb5da7bc7e3427fb9" name="gae864211a5eb052deb5da7bc7e3427fb9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae864211a5eb052deb5da7bc7e3427fb9">&#9670;&#160;</a></span>netif_create_ip6_linklocal_address()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void netif_create_ip6_linklocal_address </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">u8_t</td> <td class="paramname"><span class="paramname"><em>from_mac_48bit</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a link-local IPv6 address on a netif (stored in slot 0)</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">netif</td><td>the netif to create the address on </td></tr>
<tr><td class="paramname">from_mac_48bit</td><td>if != 0, assume hwadr is a 48-bit MAC address (std conversion) if == 0, use hwaddr directly as interface ID </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gae21572fdbd8664d22a1b281a6c31c9bb" name="gae21572fdbd8664d22a1b281a6c31c9bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae21572fdbd8664d22a1b281a6c31c9bb">&#9670;&#160;</a></span>netif_ip6_addr_set()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void netif_ip6_addr_set </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">s8_t</td> <td class="paramname"><span class="paramname"><em>addr_idx</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="ip6__addr_8h.html#aaca9e796e93a355294c4954c08d01762">ip6_addr_t</a> *</td> <td class="paramname"><span class="paramname"><em>addr6</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Change an IPv6 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">addr_idx</td><td>index of the IPv6 address </td></tr>
<tr><td class="paramname">addr6</td><td>the new IPv6 address</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>call <a class="el" href="#ga9cde7286535c7f037a9b16052561b91f">netif_ip6_addr_set_state()</a> to set the address valid/temptative </dd></dl>
</div>
</div>
<a id="ga9cde7286535c7f037a9b16052561b91f" name="ga9cde7286535c7f037a9b16052561b91f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9cde7286535c7f037a9b16052561b91f">&#9670;&#160;</a></span>netif_ip6_addr_set_state()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void netif_ip6_addr_set_state </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">s8_t</td> <td class="paramname"><span class="paramname"><em>addr_idx</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u8_t</td> <td class="paramname"><span class="paramname"><em>state</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Change the state of an IPv6 address of a network interface (INVALID, TEMPTATIVE, PREFERRED, DEPRECATED, where TEMPTATIVE includes the number of checks done, see <a class="el" href="ip6__addr_8h.html">ip6_addr.h</a>)</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">addr_idx</td><td>index of the IPv6 address </td></tr>
<tr><td class="paramname">state</td><td>the new IPv6 address state </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="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>