dhcp_8c.html 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.13"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>lwIP: src/core/ipv4/dhcp.c File Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="resize.js"></script>
  14. <script type="text/javascript" src="navtreedata.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript">
  17. $(document).ready(initResizable);
  18. </script>
  19. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  20. <script type="text/javascript" src="search/searchdata.js"></script>
  21. <script type="text/javascript" src="search/search.js"></script>
  22. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  23. </head>
  24. <body>
  25. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  26. <div id="titlearea">
  27. <table cellspacing="0" cellpadding="0">
  28. <tbody>
  29. <tr style="height: 56px;">
  30. <td id="projectalign" style="padding-left: 0.5em;">
  31. <div id="projectname">lwIP
  32. &#160;<span id="projectnumber">2.1.2</span>
  33. </div>
  34. <div id="projectbrief">Lightweight IP stack</div>
  35. </td>
  36. </tr>
  37. </tbody>
  38. </table>
  39. </div>
  40. <!-- end header part -->
  41. <!-- Generated by Doxygen 1.8.13 -->
  42. <script type="text/javascript">
  43. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  44. </script>
  45. <script type="text/javascript" src="menudata.js"></script>
  46. <script type="text/javascript" src="menu.js"></script>
  47. <script type="text/javascript">
  48. $(function() {
  49. initMenu('',true,false,'search.php','Search');
  50. $(document).ready(function() { init_search(); });
  51. });
  52. </script>
  53. <div id="main-nav"></div>
  54. </div><!-- top -->
  55. <div id="side-nav" class="ui-resizable side-nav-resizable">
  56. <div id="nav-tree">
  57. <div id="nav-tree-contents">
  58. <div id="nav-sync" class="sync"></div>
  59. </div>
  60. </div>
  61. <div id="splitbar" style="-moz-user-select:none;"
  62. class="ui-resizable-handle">
  63. </div>
  64. </div>
  65. <script type="text/javascript">
  66. $(document).ready(function(){initNavTree('dhcp_8c.html','');});
  67. </script>
  68. <div id="doc-content">
  69. <!-- window showing the filter options -->
  70. <div id="MSearchSelectWindow"
  71. onmouseover="return searchBox.OnSearchSelectShow()"
  72. onmouseout="return searchBox.OnSearchSelectHide()"
  73. onkeydown="return searchBox.OnSearchSelectKey(event)">
  74. </div>
  75. <!-- iframe showing the search results (closed by default) -->
  76. <div id="MSearchResultsWindow">
  77. <iframe src="javascript:void(0)" frameborder="0"
  78. name="MSearchResults" id="MSearchResults">
  79. </iframe>
  80. </div>
  81. <div class="header">
  82. <div class="summary">
  83. <a href="#define-members">Macros</a> &#124;
  84. <a href="#enum-members">Enumerations</a> &#124;
  85. <a href="#func-members">Functions</a> &#124;
  86. <a href="#var-members">Variables</a> </div>
  87. <div class="headertitle">
  88. <div class="title">dhcp.c File Reference</div> </div>
  89. </div><!--header-->
  90. <div class="contents">
  91. <div class="textblock"><code>#include &quot;<a class="el" href="opt_8h.html">lwip/opt.h</a>&quot;</code><br />
  92. <code>#include &quot;<a class="el" href="stats_8h.html">lwip/stats.h</a>&quot;</code><br />
  93. <code>#include &quot;<a class="el" href="mem_8h.html">lwip/mem.h</a>&quot;</code><br />
  94. <code>#include &quot;<a class="el" href="udp_8h.html">lwip/udp.h</a>&quot;</code><br />
  95. <code>#include &quot;<a class="el" href="ip__addr_8h.html">lwip/ip_addr.h</a>&quot;</code><br />
  96. <code>#include &quot;<a class="el" href="netif_8h.html">lwip/netif.h</a>&quot;</code><br />
  97. <code>#include &quot;<a class="el" href="def_8h.html">lwip/def.h</a>&quot;</code><br />
  98. <code>#include &quot;<a class="el" href="dhcp_8h.html">lwip/dhcp.h</a>&quot;</code><br />
  99. <code>#include &quot;<a class="el" href="autoip_8h.html">lwip/autoip.h</a>&quot;</code><br />
  100. <code>#include &quot;<a class="el" href="dns_8h.html">lwip/dns.h</a>&quot;</code><br />
  101. <code>#include &quot;<a class="el" href="lwip_2etharp_8h.html">lwip/etharp.h</a>&quot;</code><br />
  102. <code>#include &quot;<a class="el" href="prot_2dhcp_8h.html">lwip/prot/dhcp.h</a>&quot;</code><br />
  103. <code>#include &quot;<a class="el" href="iana_8h.html">lwip/prot/iana.h</a>&quot;</code><br />
  104. <code>#include &lt;string.h&gt;</code><br />
  105. <code>#include &quot;path/to/my/lwip_hooks.h&quot;</code><br />
  106. </div><table class="memberdecls">
  107. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
  108. Macros</h2></td></tr>
  109. <tr class="memitem:ad6de9c5120654454a330bf5de53c4835"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="dhcp_8c.html#ad6de9c5120654454a330bf5de53c4835">DHCP_CREATE_RAND_XID</a>&#160;&#160;&#160;1</td></tr>
  110. <tr class="separator:ad6de9c5120654454a330bf5de53c4835"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a63e9ec4517b80d8576f218d905e31a9b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="dhcp_8c.html#a63e9ec4517b80d8576f218d905e31a9b">DHCP_MAX_MSG_LEN</a>(<a class="el" href="structnetif.html">netif</a>)&#160;&#160;&#160;(<a class="el" href="structnetif.html">netif</a>-&gt;mtu)</td></tr>
  112. <tr class="separator:a63e9ec4517b80d8576f218d905e31a9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:aa52c2b64ef42fbad84a3bcd58052caab"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="dhcp_8c.html#aa52c2b64ef42fbad84a3bcd58052caab">DHCP_MIN_REPLY_LEN</a>&#160;&#160;&#160;44</td></tr>
  114. <tr class="separator:aa52c2b64ef42fbad84a3bcd58052caab"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. </table><table class="memberdecls">
  116. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
  117. Enumerations</h2></td></tr>
  118. <tr class="memitem:a8c3b584d223b995b48613ad96cb776a0"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="dhcp_8c.html#a8c3b584d223b995b48613ad96cb776a0">dhcp_option_idx</a> </td></tr>
  119. <tr class="separator:a8c3b584d223b995b48613ad96cb776a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. </table><table class="memberdecls">
  121. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  122. Functions</h2></td></tr>
  123. <tr class="memitem:ad7480883d64f3d6f083c8aa933b5e3cb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="dhcp_8c.html#ad7480883d64f3d6f083c8aa933b5e3cb">dhcp_coarse_tmr</a> (void)</td></tr>
  124. <tr class="separator:ad7480883d64f3d6f083c8aa933b5e3cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:a601d97faa24fa7289244bb452f052045"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="dhcp_8c.html#a601d97faa24fa7289244bb452f052045">dhcp_fine_tmr</a> (void)</td></tr>
  126. <tr class="separator:a601d97faa24fa7289244bb452f052045"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:ga43812097832716a462c660eb59cc1bf8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp4.html#ga43812097832716a462c660eb59cc1bf8">dhcp_set_struct</a> (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>, struct dhcp *dhcp)</td></tr>
  128. <tr class="separator:ga43812097832716a462c660eb59cc1bf8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:ga292a1b0c0c288ec508108a3fba473e64"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp4.html#ga292a1b0c0c288ec508108a3fba473e64">dhcp_cleanup</a> (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>)</td></tr>
  130. <tr class="separator:ga292a1b0c0c288ec508108a3fba473e64"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:ga0c50968d9811aa2aa67fadc0885d744f"><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__dhcp4.html#ga0c50968d9811aa2aa67fadc0885d744f">dhcp_start</a> (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>)</td></tr>
  132. <tr class="separator:ga0c50968d9811aa2aa67fadc0885d744f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:gabd7fcc7e0799e313885fc7fd9d4992ad"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp4.html#gabd7fcc7e0799e313885fc7fd9d4992ad">dhcp_inform</a> (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>)</td></tr>
  134. <tr class="separator:gabd7fcc7e0799e313885fc7fd9d4992ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:a04f3824720223c439165243527906002"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="dhcp_8c.html#a04f3824720223c439165243527906002">dhcp_network_changed</a> (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>)</td></tr>
  136. <tr class="separator:a04f3824720223c439165243527906002"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:a1fc0a94e0b94f13c5d302018f7ecb535"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="dhcp_8c.html#a1fc0a94e0b94f13c5d302018f7ecb535">dhcp_arp_reply</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> *addr)</td></tr>
  138. <tr class="separator:a1fc0a94e0b94f13c5d302018f7ecb535"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:ga583eb8d58f5e96b7dea717948578a947"><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__dhcp4.html#ga583eb8d58f5e96b7dea717948578a947">dhcp_renew</a> (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>)</td></tr>
  140. <tr class="separator:ga583eb8d58f5e96b7dea717948578a947"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:gaf7cd42b9f220446b6a597d3474da6ece"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp4.html#gaf7cd42b9f220446b6a597d3474da6ece">dhcp_release_and_stop</a> (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>)</td></tr>
  142. <tr class="separator:gaf7cd42b9f220446b6a597d3474da6ece"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:gaf92f7afb58252f82a749064602974bd4"><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__dhcp4.html#gaf92f7afb58252f82a749064602974bd4">dhcp_release</a> (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>)</td></tr>
  144. <tr class="separator:gaf92f7afb58252f82a749064602974bd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:ga93f6bf21086dc9b10c0bec4676f97312"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp4.html#ga93f6bf21086dc9b10c0bec4676f97312">dhcp_stop</a> (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>)</td></tr>
  146. <tr class="separator:ga93f6bf21086dc9b10c0bec4676f97312"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:ae24a2529372218327ab9cb6592041c85"><td class="memItemLeft" align="right" valign="top">u8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="dhcp_8c.html#ae24a2529372218327ab9cb6592041c85">dhcp_supplied_address</a> (const struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>)</td></tr>
  148. <tr class="separator:ae24a2529372218327ab9cb6592041c85"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. </table><table class="memberdecls">
  150. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
  151. Variables</h2></td></tr>
  152. <tr class="memitem:a5abd232496063bddcbc6692c0e8f9c1f"><td class="memItemLeft" align="right" valign="top">u32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="dhcp_8c.html#a5abd232496063bddcbc6692c0e8f9c1f">dhcp_rx_options_val</a> [DHCP_OPTION_IDX_MAX]</td></tr>
  153. <tr class="separator:a5abd232496063bddcbc6692c0e8f9c1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:a058b71e1d26b3758b29d16d9f892c8cc"><td class="memItemLeft" align="right" valign="top">u8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="dhcp_8c.html#a058b71e1d26b3758b29d16d9f892c8cc">dhcp_rx_options_given</a> [DHCP_OPTION_IDX_MAX]</td></tr>
  155. <tr class="separator:a058b71e1d26b3758b29d16d9f892c8cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. </table>
  157. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  158. <div class="textblock"><p>Dynamic Host Configuration Protocol client </p>
  159. </div><h2 class="groupheader">Macro Definition Documentation</h2>
  160. <a id="ad6de9c5120654454a330bf5de53c4835"></a>
  161. <h2 class="memtitle"><span class="permalink"><a href="#ad6de9c5120654454a330bf5de53c4835">&#9670;&nbsp;</a></span>DHCP_CREATE_RAND_XID</h2>
  162. <div class="memitem">
  163. <div class="memproto">
  164. <table class="memname">
  165. <tr>
  166. <td class="memname">#define DHCP_CREATE_RAND_XID&#160;&#160;&#160;1</td>
  167. </tr>
  168. </table>
  169. </div><div class="memdoc">
  170. <p>DHCP_CREATE_RAND_XID: if this is set to 1, the xid is created using <a class="el" href="group__compiler__abstraction.html#ga77370c377781ee7489e30eaf772ea05a">LWIP_RAND()</a> (this overrides DHCP_GLOBAL_XID) </p>
  171. </div>
  172. </div>
  173. <a id="a63e9ec4517b80d8576f218d905e31a9b"></a>
  174. <h2 class="memtitle"><span class="permalink"><a href="#a63e9ec4517b80d8576f218d905e31a9b">&#9670;&nbsp;</a></span>DHCP_MAX_MSG_LEN</h2>
  175. <div class="memitem">
  176. <div class="memproto">
  177. <table class="memname">
  178. <tr>
  179. <td class="memname">#define DHCP_MAX_MSG_LEN</td>
  180. <td>(</td>
  181. <td class="paramtype">&#160;</td>
  182. <td class="paramname"><a class="el" href="structnetif.html">netif</a></td><td>)</td>
  183. <td>&#160;&#160;&#160;(<a class="el" href="structnetif.html">netif</a>-&gt;mtu)</td>
  184. </tr>
  185. </table>
  186. </div><div class="memdoc">
  187. <p>Default for DHCP_GLOBAL_XID is 0xABCD0000 This can be changed by defining DHCP_GLOBAL_XID and DHCP_GLOBAL_XID_HEADER, e.g. #define DHCP_GLOBAL_XID_HEADER "stdlib.h" #define DHCP_GLOBAL_XID rand() DHCP_OPTION_MAX_MSG_SIZE is set to the MTU MTU is checked to be big enough in dhcp_start </p>
  188. </div>
  189. </div>
  190. <a id="aa52c2b64ef42fbad84a3bcd58052caab"></a>
  191. <h2 class="memtitle"><span class="permalink"><a href="#aa52c2b64ef42fbad84a3bcd58052caab">&#9670;&nbsp;</a></span>DHCP_MIN_REPLY_LEN</h2>
  192. <div class="memitem">
  193. <div class="memproto">
  194. <table class="memname">
  195. <tr>
  196. <td class="memname">#define DHCP_MIN_REPLY_LEN&#160;&#160;&#160;44</td>
  197. </tr>
  198. </table>
  199. </div><div class="memdoc">
  200. <p>Minimum length for reply before packet is parsed </p>
  201. </div>
  202. </div>
  203. <h2 class="groupheader">Enumeration Type Documentation</h2>
  204. <a id="a8c3b584d223b995b48613ad96cb776a0"></a>
  205. <h2 class="memtitle"><span class="permalink"><a href="#a8c3b584d223b995b48613ad96cb776a0">&#9670;&nbsp;</a></span>dhcp_option_idx</h2>
  206. <div class="memitem">
  207. <div class="memproto">
  208. <table class="memname">
  209. <tr>
  210. <td class="memname">enum <a class="el" href="dhcp_8c.html#a8c3b584d223b995b48613ad96cb776a0">dhcp_option_idx</a></td>
  211. </tr>
  212. </table>
  213. </div><div class="memdoc">
  214. <p>Option handling: options are parsed in dhcp_parse_reply and saved in an array where other functions can load them from. This might be moved into the struct dhcp (not necessarily since lwIP is single-threaded and the array is only used while in recv callback). </p>
  215. </div>
  216. </div>
  217. <h2 class="groupheader">Function Documentation</h2>
  218. <a id="a1fc0a94e0b94f13c5d302018f7ecb535"></a>
  219. <h2 class="memtitle"><span class="permalink"><a href="#a1fc0a94e0b94f13c5d302018f7ecb535">&#9670;&nbsp;</a></span>dhcp_arp_reply()</h2>
  220. <div class="memitem">
  221. <div class="memproto">
  222. <table class="memname">
  223. <tr>
  224. <td class="memname">void dhcp_arp_reply </td>
  225. <td>(</td>
  226. <td class="paramtype">struct <a class="el" href="structnetif.html">netif</a> *&#160;</td>
  227. <td class="paramname"><em>netif</em>, </td>
  228. </tr>
  229. <tr>
  230. <td class="paramkey"></td>
  231. <td></td>
  232. <td class="paramtype">const <a class="el" href="ip4__addr_8h.html#a3d3b45daffbc15d65da236e31e621b7e">ip4_addr_t</a> *&#160;</td>
  233. <td class="paramname"><em>addr</em>&#160;</td>
  234. </tr>
  235. <tr>
  236. <td></td>
  237. <td>)</td>
  238. <td></td><td></td>
  239. </tr>
  240. </table>
  241. </div><div class="memdoc">
  242. <p>Match an ARP reply with the offered IP address: check whether the offered IP address is not in use using ARP</p>
  243. <dl class="params"><dt>Parameters</dt><dd>
  244. <table class="params">
  245. <tr><td class="paramname">netif</td><td>the network interface on which the reply was received </td></tr>
  246. <tr><td class="paramname">addr</td><td>The IP address we received a reply from </td></tr>
  247. </table>
  248. </dd>
  249. </dl>
  250. </div>
  251. </div>
  252. <a id="ad7480883d64f3d6f083c8aa933b5e3cb"></a>
  253. <h2 class="memtitle"><span class="permalink"><a href="#ad7480883d64f3d6f083c8aa933b5e3cb">&#9670;&nbsp;</a></span>dhcp_coarse_tmr()</h2>
  254. <div class="memitem">
  255. <div class="memproto">
  256. <table class="memname">
  257. <tr>
  258. <td class="memname">void dhcp_coarse_tmr </td>
  259. <td>(</td>
  260. <td class="paramtype">void&#160;</td>
  261. <td class="paramname"></td><td>)</td>
  262. <td></td>
  263. </tr>
  264. </table>
  265. </div><div class="memdoc">
  266. <p>The DHCP timer that checks for lease renewal/rebind timeouts. Must be called once a minute (see <a class="el" href="dhcp_8h.html#a3751cc5daa0875d415ebacd8ad675f1e">DHCP_COARSE_TIMER_SECS</a>). </p>
  267. </div>
  268. </div>
  269. <a id="a601d97faa24fa7289244bb452f052045"></a>
  270. <h2 class="memtitle"><span class="permalink"><a href="#a601d97faa24fa7289244bb452f052045">&#9670;&nbsp;</a></span>dhcp_fine_tmr()</h2>
  271. <div class="memitem">
  272. <div class="memproto">
  273. <table class="memname">
  274. <tr>
  275. <td class="memname">void dhcp_fine_tmr </td>
  276. <td>(</td>
  277. <td class="paramtype">void&#160;</td>
  278. <td class="paramname"></td><td>)</td>
  279. <td></td>
  280. </tr>
  281. </table>
  282. </div><div class="memdoc">
  283. <p>DHCP transaction timeout handling (this function must be called every 500ms, see <a class="el" href="dhcp_8h.html#a7a26209f52eebe8ded457ae141df403f">DHCP_FINE_TIMER_MSECS</a>).</p>
  284. <p>A DHCP server is expected to respond within a short period of time. This timer checks whether an outstanding DHCP request is timed out. </p>
  285. </div>
  286. </div>
  287. <a id="a04f3824720223c439165243527906002"></a>
  288. <h2 class="memtitle"><span class="permalink"><a href="#a04f3824720223c439165243527906002">&#9670;&nbsp;</a></span>dhcp_network_changed()</h2>
  289. <div class="memitem">
  290. <div class="memproto">
  291. <table class="memname">
  292. <tr>
  293. <td class="memname">void dhcp_network_changed </td>
  294. <td>(</td>
  295. <td class="paramtype">struct <a class="el" href="structnetif.html">netif</a> *&#160;</td>
  296. <td class="paramname"><em>netif</em></td><td>)</td>
  297. <td></td>
  298. </tr>
  299. </table>
  300. </div><div class="memdoc">
  301. <p>Handle a possible change in the network configuration.</p>
  302. <p>This enters the REBOOTING state to verify that the currently bound address is still valid. </p>
  303. </div>
  304. </div>
  305. <a id="ae24a2529372218327ab9cb6592041c85"></a>
  306. <h2 class="memtitle"><span class="permalink"><a href="#ae24a2529372218327ab9cb6592041c85">&#9670;&nbsp;</a></span>dhcp_supplied_address()</h2>
  307. <div class="memitem">
  308. <div class="memproto">
  309. <table class="memname">
  310. <tr>
  311. <td class="memname">u8_t dhcp_supplied_address </td>
  312. <td>(</td>
  313. <td class="paramtype">const struct <a class="el" href="structnetif.html">netif</a> *&#160;</td>
  314. <td class="paramname"><em>netif</em></td><td>)</td>
  315. <td></td>
  316. </tr>
  317. </table>
  318. </div><div class="memdoc">
  319. <p>check if DHCP supplied netif-&gt;<a class="el" href="structip__addr.html">ip_addr</a></p>
  320. <dl class="params"><dt>Parameters</dt><dd>
  321. <table class="params">
  322. <tr><td class="paramname">netif</td><td>the netif to check </td></tr>
  323. </table>
  324. </dd>
  325. </dl>
  326. <dl class="section return"><dt>Returns</dt><dd>1 if DHCP supplied netif-&gt;<a class="el" href="structip__addr.html">ip_addr</a> (states BOUND or RENEWING), 0 otherwise </dd></dl>
  327. </div>
  328. </div>
  329. <h2 class="groupheader">Variable Documentation</h2>
  330. <a id="a058b71e1d26b3758b29d16d9f892c8cc"></a>
  331. <h2 class="memtitle"><span class="permalink"><a href="#a058b71e1d26b3758b29d16d9f892c8cc">&#9670;&nbsp;</a></span>dhcp_rx_options_given</h2>
  332. <div class="memitem">
  333. <div class="memproto">
  334. <table class="memname">
  335. <tr>
  336. <td class="memname">u8_t dhcp_rx_options_given[DHCP_OPTION_IDX_MAX]</td>
  337. </tr>
  338. </table>
  339. </div><div class="memdoc">
  340. <p>Holds a flag which option was received and is contained in dhcp_rx_options_val, only valid while in dhcp_recv. </p>
  341. </div>
  342. </div>
  343. <a id="a5abd232496063bddcbc6692c0e8f9c1f"></a>
  344. <h2 class="memtitle"><span class="permalink"><a href="#a5abd232496063bddcbc6692c0e8f9c1f">&#9670;&nbsp;</a></span>dhcp_rx_options_val</h2>
  345. <div class="memitem">
  346. <div class="memproto">
  347. <table class="memname">
  348. <tr>
  349. <td class="memname">u32_t dhcp_rx_options_val[DHCP_OPTION_IDX_MAX]</td>
  350. </tr>
  351. </table>
  352. </div><div class="memdoc">
  353. <p>Holds the decoded option values, only valid while in dhcp_recv. </p>
  354. </div>
  355. </div>
  356. </div><!-- contents -->
  357. </div><!-- doc-content -->
  358. <!-- start footer part -->
  359. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  360. <ul>
  361. <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_a32e111ee6805cfc63488fd2d37f2390.html">ipv4</a></li><li class="navelem"><a class="el" href="dhcp_8c.html">dhcp.c</a></li>
  362. <li class="footer">Generated by
  363. <a href="http://www.doxygen.org/index.html">
  364. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  365. </ul>
  366. </div>
  367. </body>
  368. </html>