blob: 689294cd1e6ef923771c2608d1b2f4df19273f22 [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/core/ipv6/mld6.c 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('mld6_8c.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">mld6.c 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="mld6_8h.html">lwip/mld6.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="prot_2mld6_8h.html">lwip/prot/mld6.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="icmp6_8h.html">lwip/icmp6.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="ip6_8h.html">lwip/ip6.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="ip6__addr_8h.html">lwip/ip6_addr.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="ip_8h.html">lwip/ip.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="inet__chksum_8h.html">lwip/inet_chksum.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="pbuf_8h.html">lwip/pbuf.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="netif_8h.html">lwip/netif.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="memp_8h.html">lwip/memp.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="stats_8h.html">lwip/stats.h</a>&quot;</code><br />
<code>#include &lt;string.h&gt;</code><br />
</div><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:ab7197d123f21a8863b56cc3871fd5198" id="r_ab7197d123f21a8863b56cc3871fd5198"><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="#ab7197d123f21a8863b56cc3871fd5198">mld6_stop</a> (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>)</td></tr>
<tr class="separator:ab7197d123f21a8863b56cc3871fd5198"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a08b95a7b3c82da05df1a3b50629686" id="r_a2a08b95a7b3c82da05df1a3b50629686"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2a08b95a7b3c82da05df1a3b50629686">mld6_report_groups</a> (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>)</td></tr>
<tr class="separator:a2a08b95a7b3c82da05df1a3b50629686"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a496197eef3f8b4c2a0fd49734aee07d6" id="r_a496197eef3f8b4c2a0fd49734aee07d6"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structmld__group.html">mld_group</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a496197eef3f8b4c2a0fd49734aee07d6">mld6_lookfor_group</a> (struct <a class="el" href="structnetif.html">netif</a> *ifp, const <a class="el" href="ip6__addr_8h.html#aaca9e796e93a355294c4954c08d01762">ip6_addr_t</a> *addr)</td></tr>
<tr class="separator:a496197eef3f8b4c2a0fd49734aee07d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c190ca25432d466b28f607c3574a841" id="r_a7c190ca25432d466b28f607c3574a841"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7c190ca25432d466b28f607c3574a841">mld6_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:a7c190ca25432d466b28f607c3574a841"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga53560ab6e47163e4888070830bf912a8" id="r_ga53560ab6e47163e4888070830bf912a8"><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="group__mld6.html#ga53560ab6e47163e4888070830bf912a8">mld6_joingroup</a> (const <a class="el" href="ip6__addr_8h.html#aaca9e796e93a355294c4954c08d01762">ip6_addr_t</a> *srcaddr, const <a class="el" href="ip6__addr_8h.html#aaca9e796e93a355294c4954c08d01762">ip6_addr_t</a> *groupaddr)</td></tr>
<tr class="separator:ga53560ab6e47163e4888070830bf912a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2ba41d575a56d27c0af0a08fb8724940" id="r_ga2ba41d575a56d27c0af0a08fb8724940"><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="group__mld6.html#ga2ba41d575a56d27c0af0a08fb8724940">mld6_joingroup_netif</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> *groupaddr)</td></tr>
<tr class="separator:ga2ba41d575a56d27c0af0a08fb8724940"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga946b830efc6fd795b07a0964dc7940e5" id="r_ga946b830efc6fd795b07a0964dc7940e5"><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="group__mld6.html#ga946b830efc6fd795b07a0964dc7940e5">mld6_leavegroup</a> (const <a class="el" href="ip6__addr_8h.html#aaca9e796e93a355294c4954c08d01762">ip6_addr_t</a> *srcaddr, const <a class="el" href="ip6__addr_8h.html#aaca9e796e93a355294c4954c08d01762">ip6_addr_t</a> *groupaddr)</td></tr>
<tr class="separator:ga946b830efc6fd795b07a0964dc7940e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab664062a15a3ae3e05282eacf4dc0a22" id="r_gab664062a15a3ae3e05282eacf4dc0a22"><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="group__mld6.html#gab664062a15a3ae3e05282eacf4dc0a22">mld6_leavegroup_netif</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> *groupaddr)</td></tr>
<tr class="separator:gab664062a15a3ae3e05282eacf4dc0a22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ddb496d0a6a466df5665dbed8bd6274" id="r_a4ddb496d0a6a466df5665dbed8bd6274"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4ddb496d0a6a466df5665dbed8bd6274">mld6_tmr</a> (void)</td></tr>
<tr class="separator:a4ddb496d0a6a466df5665dbed8bd6274"><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>Multicast listener discovery </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a7c190ca25432d466b28f607c3574a841" name="a7c190ca25432d466b28f607c3574a841"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c190ca25432d466b28f607c3574a841">&#9670;&#160;</a></span>mld6_input()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mld6_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>Process an input MLD message. Called by icmp6_input.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>the mld packet, p-&gt;payload pointing to the icmpv6 header </td></tr>
<tr><td class="paramname">inp</td><td>the netif on which this packet was received </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a496197eef3f8b4c2a0fd49734aee07d6" name="a496197eef3f8b4c2a0fd49734aee07d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a496197eef3f8b4c2a0fd49734aee07d6">&#9670;&#160;</a></span>mld6_lookfor_group()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structmld__group.html">mld_group</a> * mld6_lookfor_group </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structnetif.html">netif</a> *</td> <td class="paramname"><span class="paramname"><em>ifp</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>addr</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Search for a group that is joined on a netif</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ifp</td><td>the network interface for which to look </td></tr>
<tr><td class="paramname">addr</td><td>the group ipv6 address to search for </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a struct mld_group* if the group has been found, NULL if the group wasn't found. </dd></dl>
</div>
</div>
<a id="a2a08b95a7b3c82da05df1a3b50629686" name="a2a08b95a7b3c82da05df1a3b50629686"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2a08b95a7b3c82da05df1a3b50629686">&#9670;&#160;</a></span>mld6_report_groups()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mld6_report_groups </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><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Report MLD memberships for this interface</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">netif</td><td>network interface on which report MLD memberships </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab7197d123f21a8863b56cc3871fd5198" name="ab7197d123f21a8863b56cc3871fd5198"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab7197d123f21a8863b56cc3871fd5198">&#9670;&#160;</a></span>mld6_stop()</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> mld6_stop </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><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Stop MLD processing on interface</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">netif</td><td>network interface on which stop MLD processing </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4ddb496d0a6a466df5665dbed8bd6274" name="a4ddb496d0a6a466df5665dbed8bd6274"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4ddb496d0a6a466df5665dbed8bd6274">&#9670;&#160;</a></span>mld6_tmr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mld6_tmr </td>
<td>(</td>
<td class="paramtype">void</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Periodic timer for mld processing. Must be called every MLD6_TMR_INTERVAL milliseconds (100).</p>
<p>When a delaying member expires, a membership report is sent. </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_aebb8dcc11953d78e620bbef0b9e2183.html">core</a></li><li class="navelem"><a class="el" href="dir_da9c6f43d3cd00be3de224bac907a425.html">ipv6</a></li><li class="navelem"><a class="el" href="mld6_8c.html">mld6.c</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>