<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.16"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>UbixOS: include/net/igmp.h Source File</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>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">UbixOS
 <span id="projectnumber">2.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('../../',false,false,'search.php','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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('d9/d9c/igmp_8h_source.html','../../');});
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">igmp.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="../../d9/d9c/igmp_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>  </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * Copyright (c) 2002 CITEL Technologies Ltd.</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * All rights reserved.</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * Redistribution and use in source and binary forms, with or without</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * modification, are permitted provided that the following conditions</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * are met:</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * 1. Redistributions of source code must retain the above copyright</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * notice, this list of conditions and the following disclaimer.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * notice, this list of conditions and the following disclaimer in the</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * documentation and/or other materials provided with the distribution.</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * 3. Neither the name of CITEL Technologies Ltd nor the names of its contributors</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * may be used to endorse or promote products derived from this software</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * without specific prior written permission.</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * THIS SOFTWARE IS PROVIDED BY CITEL TECHNOLOGIES AND CONTRIBUTORS ``AS IS''</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL CITEL TECHNOLOGIES OR CONTRIBUTORS BE LIABLE</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> * SUCH DAMAGE.</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> * This file is a contribution to the lwIP TCP/IP stack.</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> * The Swedish Institute of Computer Science and Adam Dunkels</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> * are specifically granted permission to redistribute this</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> * source code.</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#ifndef LWIP_HDR_IGMP_H</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#define LWIP_HDR_IGMP_H</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#include "<a class="code" href="../../dc/dba/opt_8h.html">net/opt.h</a>"</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor">#include "<a class="code" href="../../de/df7/ip__addr_8h.html">net/ip_addr.h</a>"</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#include "<a class="code" href="../../d9/d69/netif_8h.html">net/netif.h</a>"</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#include "<a class="code" href="../../d0/d35/pbuf_8h.html">net/pbuf.h</a>"</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#if LWIP_IPV4 && LWIP_IGMP </span><span class="comment">/* don't build if not configured for use in lwipopts.h */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">/* IGMP timer */</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">#define IGMP_TMR_INTERVAL 100 </span><span class="comment">/* Milliseconds */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor">#define IGMP_V1_DELAYING_MEMBER_TMR (1000/IGMP_TMR_INTERVAL)</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#define IGMP_JOIN_DELAYING_MEMBER_TMR (500 /IGMP_TMR_INTERVAL)</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">/* Compatibility defines (don't use for new code) */</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="preprocessor">#define IGMP_DEL_MAC_FILTER NETIF_DEL_MAC_FILTER</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor">#define IGMP_ADD_MAC_FILTER NETIF_ADD_MAC_FILTER</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  </div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="keyword">struct </span>igmp_group {</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">struct </span>igmp_group *next;</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  ip4_addr_t group_address;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <a class="code" href="../../de/d8c/group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> last_reporter_flag;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <a class="code" href="../../de/d8c/group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> group_state;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <a class="code" href="../../de/d8c/group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a> timer;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <a class="code" href="../../de/d8c/group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> use;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> };</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment">/* Prototypes */</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="keywordtype">void</span> igmp_init(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <a class="code" href="../../d2/de7/group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a> igmp_start(<span class="keyword">struct</span> <a class="code" href="../../d2/dd6/structnetif.html">netif</a> *<a class="code" href="../../d2/dd6/structnetif.html">netif</a>);</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <a class="code" href="../../d2/de7/group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a> igmp_stop(<span class="keyword">struct</span> <a class="code" href="../../d2/dd6/structnetif.html">netif</a> *<a class="code" href="../../d2/dd6/structnetif.html">netif</a>);</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="keywordtype">void</span> igmp_report_groups(<span class="keyword">struct</span> <a class="code" href="../../d2/dd6/structnetif.html">netif</a> *<a class="code" href="../../d2/dd6/structnetif.html">netif</a>);</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="keyword">struct </span>igmp_group *igmp_lookfor_group(<span class="keyword">struct</span> <a class="code" href="../../d2/dd6/structnetif.html">netif</a> *ifp, <span class="keyword">const</span> ip4_addr_t *addr);</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="keywordtype">void</span> igmp_input(<span class="keyword">struct</span> <a class="code" href="../../d9/db8/structpbuf.html">pbuf</a> *p, <span class="keyword">struct</span> <a class="code" href="../../d2/dd6/structnetif.html">netif</a> *inp, <span class="keyword">const</span> ip4_addr_t *dest);</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <a class="code" href="../../d2/de7/group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a> igmp_joingroup(<span class="keyword">const</span> ip4_addr_t *ifaddr, <span class="keyword">const</span> ip4_addr_t *groupaddr);</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <a class="code" href="../../d2/de7/group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a> igmp_joingroup_netif(<span class="keyword">struct</span> <a class="code" href="../../d2/dd6/structnetif.html">netif</a> *<a class="code" href="../../d2/dd6/structnetif.html">netif</a>, <span class="keyword">const</span> ip4_addr_t *groupaddr);</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <a class="code" href="../../d2/de7/group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a> igmp_leavegroup(<span class="keyword">const</span> ip4_addr_t *ifaddr, <span class="keyword">const</span> ip4_addr_t *groupaddr);</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <a class="code" href="../../d2/de7/group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a> igmp_leavegroup_netif(<span class="keyword">struct</span> <a class="code" href="../../d2/dd6/structnetif.html">netif</a> *<a class="code" href="../../d2/dd6/structnetif.html">netif</a>, <span class="keyword">const</span> ip4_addr_t *groupaddr);</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="keywordtype">void</span> igmp_tmr(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  </div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="preprocessor">#define netif_igmp_data(netif) ((struct igmp_group *)netif_get_client_data(netif, LWIP_NETIF_CLIENT_DATA_INDEX_IGMP))</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  </div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> }</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  </div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="preprocessor">#endif </span><span class="comment">/* LWIP_IPV4 && LWIP_IGMP */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  </div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="preprocessor">#endif </span><span class="comment">/* LWIP_HDR_IGMP_H */</span><span class="preprocessor"></span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aopt_8h_html"><div class="ttname"><a href="../../dc/dba/opt_8h.html">opt.h</a></div></div>
<div class="ttc" id="apbuf_8h_html"><div class="ttname"><a href="../../d0/d35/pbuf_8h.html">pbuf.h</a></div></div>
<div class="ttc" id="agroup__compiler__abstraction_html_ga77570ac4fcab86864fa1916e55676da2"><div class="ttname"><a href="../../de/d8c/group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a></div><div class="ttdeci">uint16_t u16_t</div><div class="ttdef"><b>Definition:</b> <a href="../../d2/d2d/arch_8h_source.html#l00124">arch.h:124</a></div></div>
<div class="ttc" id="anetif_8h_html"><div class="ttname"><a href="../../d9/d69/netif_8h.html">netif.h</a></div></div>
<div class="ttc" id="agroup__compiler__abstraction_html_ga4caecabca98b43919dd11be1c0d4cd8e"><div class="ttname"><a href="../../de/d8c/group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a></div><div class="ttdeci">uint8_t u8_t</div><div class="ttdef"><b>Definition:</b> <a href="../../d2/d2d/arch_8h_source.html#l00122">arch.h:122</a></div></div>
<div class="ttc" id="astructnetif_html"><div class="ttname"><a href="../../d2/dd6/structnetif.html">netif</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d9/d69/netif_8h_source.html#l00233">netif.h:233</a></div></div>
<div class="ttc" id="agroup__infrastructure__errors_html_gaf02d9da80fd66b4f986d2c53d7231ddb"><div class="ttname"><a href="../../d2/de7/group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a></div><div class="ttdeci">s8_t err_t</div><div class="ttdef"><b>Definition:</b> <a href="../../d6/d40/err_8h_source.html#l00057">err.h:57</a></div></div>
<div class="ttc" id="astructpbuf_html"><div class="ttname"><a href="../../d9/db8/structpbuf.html">pbuf</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d0/d35/pbuf_8h_source.html#l00142">pbuf.h:142</a></div></div>
<div class="ttc" id="aip__addr_8h_html"><div class="ttname"><a href="../../de/df7/ip__addr_8h.html">ip_addr.h</a></div></div>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="../../dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="../../dir_2fa1ed3146d6c2b96c5cfe4341985326.html">net</a></li><li class="navelem"><a class="el" href="../../d9/d9c/igmp_8h.html">igmp.h</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.16 </li>
</ul>
</div>
</body>
</html>
