Google Git
Sign in
pigweed / third_party / github / STMicroelectronics / stm32_mw_lwip / refs/heads/main / . / doc / doxygen / output / html / group__mdns__opts.html
blob: 70ec980a75c196359022bf36d241943b69651d87 [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: Options</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.2.0</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__mdns__opts.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> </div>
<div class="headertitle"><div class="title">Options<div class="ingroups"><a class="el" href="group__apps.html">Applications</a> &raquo; <a class="el" href="group__mdns.html">MDNS</a></div></div></div>
</div><!--header-->
<div class="contents">
<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:ga82749ee08be21967b6daf577b9710ac6" id="r_ga82749ee08be21967b6daf577b9710ac6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga82749ee08be21967b6daf577b9710ac6">MDNS_MAX_SERVICES</a>&#160;&#160;&#160;1</td></tr>
<tr class="separator:ga82749ee08be21967b6daf577b9710ac6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7f6853d01ad32eb6ce99ae55307a37d9" id="r_ga7f6853d01ad32eb6ce99ae55307a37d9"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga7f6853d01ad32eb6ce99ae55307a37d9">MDNS_PROBE_DELAY_MS</a>&#160;&#160;&#160;250</td></tr>
<tr class="separator:ga7f6853d01ad32eb6ce99ae55307a37d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga827d1d2abd24a26638723cfd0a8b9efd" id="r_ga827d1d2abd24a26638723cfd0a8b9efd"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga827d1d2abd24a26638723cfd0a8b9efd">MDNS_MAX_STORED_PKTS</a>&#160;&#160;&#160;4</td></tr>
<tr class="separator:ga827d1d2abd24a26638723cfd0a8b9efd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0f0adf7b1d742b4ea818c1b7f6b0c547" id="r_ga0f0adf7b1d742b4ea818c1b7f6b0c547"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga0f0adf7b1d742b4ea818c1b7f6b0c547">MDNS_OUTPUT_PACKET_SIZE</a>&#160;&#160;&#160;((<a class="el" href="#ga82749ee08be21967b6daf577b9710ac6">MDNS_MAX_SERVICES</a> == 1) ? 512 : 1450)</td></tr>
<tr class="separator:ga0f0adf7b1d742b4ea818c1b7f6b0c547"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga172e579cd09a1db51cf224319c012396" id="r_ga172e579cd09a1db51cf224319c012396"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga172e579cd09a1db51cf224319c012396">MDNS_RESP_USENETIF_EXTCALLBACK</a>&#160;&#160;&#160;<a class="el" href="group__lwip__opts__netif.html#ga090482867ba04d442ab5b8ad745c0e1e">LWIP_NETIF_EXT_STATUS_CALLBACK</a></td></tr>
<tr class="separator:ga172e579cd09a1db51cf224319c012396"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaaf489604dcdf94d2adcd723f6c7d7163" id="r_gaaf489604dcdf94d2adcd723f6c7d7163"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gaaf489604dcdf94d2adcd723f6c7d7163">LWIP_MDNS_SEARCH</a>&#160;&#160;&#160;1</td></tr>
<tr class="separator:gaaf489604dcdf94d2adcd723f6c7d7163"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga17a9884af8169cf19d57d8005fc3d95e" id="r_ga17a9884af8169cf19d57d8005fc3d95e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga17a9884af8169cf19d57d8005fc3d95e">MDNS_MAX_REQUESTS</a>&#160;&#160;&#160;2</td></tr>
<tr class="separator:ga17a9884af8169cf19d57d8005fc3d95e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga53a97502efdcf1214cab4078f93a6dc9" id="r_ga53a97502efdcf1214cab4078f93a6dc9"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga53a97502efdcf1214cab4078f93a6dc9">MDNS_DEBUG</a>&#160;&#160;&#160;<a class="el" href="group__debugging__levels.html#gadab1cdc3f45939a3a5c9a3d7e04987e1">LWIP_DBG_OFF</a></td></tr>
<tr class="separator:ga53a97502efdcf1214cab4078f93a6dc9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="gaaf489604dcdf94d2adcd723f6c7d7163" name="gaaf489604dcdf94d2adcd723f6c7d7163"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaaf489604dcdf94d2adcd723f6c7d7163">&#9670;&#160;</a></span>LWIP_MDNS_SEARCH</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define LWIP_MDNS_SEARCH&#160;&#160;&#160;1</td>
</tr>
</table>
</div><div class="memdoc">
<p>LWIP_MDNS_SEARCH==1: Turn on search over multicast DNS module. </p>
</div>
</div>
<a id="ga53a97502efdcf1214cab4078f93a6dc9" name="ga53a97502efdcf1214cab4078f93a6dc9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga53a97502efdcf1214cab4078f93a6dc9">&#9670;&#160;</a></span>MDNS_DEBUG</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MDNS_DEBUG&#160;&#160;&#160;<a class="el" href="group__debugging__levels.html#gadab1cdc3f45939a3a5c9a3d7e04987e1">LWIP_DBG_OFF</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>MDNS_DEBUG: Enable debugging for multicast DNS. </p>
</div>
</div>
<a id="ga17a9884af8169cf19d57d8005fc3d95e" name="ga17a9884af8169cf19d57d8005fc3d95e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga17a9884af8169cf19d57d8005fc3d95e">&#9670;&#160;</a></span>MDNS_MAX_REQUESTS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MDNS_MAX_REQUESTS&#160;&#160;&#160;2</td>
</tr>
</table>
</div><div class="memdoc">
<p>The maximum number of running requests </p>
</div>
</div>
<a id="ga82749ee08be21967b6daf577b9710ac6" name="ga82749ee08be21967b6daf577b9710ac6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga82749ee08be21967b6daf577b9710ac6">&#9670;&#160;</a></span>MDNS_MAX_SERVICES</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MDNS_MAX_SERVICES&#160;&#160;&#160;1</td>
</tr>
</table>
</div><div class="memdoc">
<p>LWIP_MDNS_RESPONDER==1: Turn on multicast DNS module. UDP must be available for MDNS transport. IGMP is needed for IPv4 multicast. The maximum number of services per netif </p>
</div>
</div>
<a id="ga827d1d2abd24a26638723cfd0a8b9efd" name="ga827d1d2abd24a26638723cfd0a8b9efd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga827d1d2abd24a26638723cfd0a8b9efd">&#9670;&#160;</a></span>MDNS_MAX_STORED_PKTS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MDNS_MAX_STORED_PKTS&#160;&#160;&#160;4</td>
</tr>
</table>
</div><div class="memdoc">
<p>The maximum number of received packets stored in chained list of known answers for pending truncated questions. This value define the size of the MDNS_PKTS mempool. Up to MDNS_MAX_STORED_PKTS pbuf can be stored in addition to TC questions that are pending. </p>
</div>
</div>
<a id="ga0f0adf7b1d742b4ea818c1b7f6b0c547" name="ga0f0adf7b1d742b4ea818c1b7f6b0c547"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0f0adf7b1d742b4ea818c1b7f6b0c547">&#9670;&#160;</a></span>MDNS_OUTPUT_PACKET_SIZE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MDNS_OUTPUT_PACKET_SIZE&#160;&#160;&#160;((<a class="el" href="#ga82749ee08be21967b6daf577b9710ac6">MDNS_MAX_SERVICES</a> == 1) ? 512 : 1450)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Payload size allocated for each outgoing UDP packet. Will be allocated with PBUF_RAM and freed after packet was sent. According to RFC 6762, there is no reason to retain the 512 bytes restriction for link-local multicast packet. 512 bytes isn't enough when 2 services need to be probed. </p>
</div>
</div>
<a id="ga7f6853d01ad32eb6ce99ae55307a37d9" name="ga7f6853d01ad32eb6ce99ae55307a37d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7f6853d01ad32eb6ce99ae55307a37d9">&#9670;&#160;</a></span>MDNS_PROBE_DELAY_MS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MDNS_PROBE_DELAY_MS&#160;&#160;&#160;250</td>
</tr>
</table>
</div><div class="memdoc">
<p>The minimum delay between probes in ms. RFC 6762 require 250ms. In noisy WiFi environment, adding 30-50ms to this value help a lot for a successful Apple BCT tests. </p>
</div>
</div>
<a id="ga172e579cd09a1db51cf224319c012396" name="ga172e579cd09a1db51cf224319c012396"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga172e579cd09a1db51cf224319c012396">&#9670;&#160;</a></span>MDNS_RESP_USENETIF_EXTCALLBACK</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MDNS_RESP_USENETIF_EXTCALLBACK&#160;&#160;&#160;<a class="el" href="group__lwip__opts__netif.html#ga090482867ba04d442ab5b8ad745c0e1e">LWIP_NETIF_EXT_STATUS_CALLBACK</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>MDNS_RESP_USENETIF_EXTCALLBACK==1: register an ext_callback on the netif to automatically restart probing/announcing on status or address change. </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="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>