blob: db4f256e10003338ba60cfa20a6b7c8efff3275b [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: DHCPv4</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__netifapi__dhcp4.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">DHCPv4<div class="ingroups"><a class="el" href="group__api.html">APIs</a> &raquo; <a class="el" href="group__sequential__api.html">Sequential-style APIs</a> &raquo; <a class="el" href="group__netifapi.html">NETIF API</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:gae64d13afc6e3b0f21aae04b66d0e3765" id="r_gae64d13afc6e3b0f21aae04b66d0e3765"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gae64d13afc6e3b0f21aae04b66d0e3765">netifapi_dhcp_start</a>(n)</td></tr>
<tr class="separator:gae64d13afc6e3b0f21aae04b66d0e3765"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2322c0d0e3eb6c1097d6f3942905dbd5" id="r_ga2322c0d0e3eb6c1097d6f3942905dbd5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga2322c0d0e3eb6c1097d6f3942905dbd5">netifapi_dhcp_stop</a>(n)</td></tr>
<tr class="separator:ga2322c0d0e3eb6c1097d6f3942905dbd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga29108975e9aa6463b9a574de961317e0" id="r_ga29108975e9aa6463b9a574de961317e0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga29108975e9aa6463b9a574de961317e0">netifapi_dhcp_inform</a>(n)</td></tr>
<tr class="separator:ga29108975e9aa6463b9a574de961317e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga642390e5efa53ad3095e01331c6a936b" id="r_ga642390e5efa53ad3095e01331c6a936b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga642390e5efa53ad3095e01331c6a936b">netifapi_dhcp_renew</a>(n)</td></tr>
<tr class="separator:ga642390e5efa53ad3095e01331c6a936b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5aeaee24c11128df90a56fe091c9d409" id="r_ga5aeaee24c11128df90a56fe091c9d409"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga5aeaee24c11128df90a56fe091c9d409">netifapi_dhcp_release</a>(n)</td></tr>
<tr class="separator:ga5aeaee24c11128df90a56fe091c9d409"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1971af04f882f5afdb3ade454a680134" id="r_ga1971af04f882f5afdb3ade454a680134"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga1971af04f882f5afdb3ade454a680134">netifapi_dhcp_release_and_stop</a>(n)</td></tr>
<tr class="separator:ga1971af04f882f5afdb3ade454a680134"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>To be called from non-TCPIP threads </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga29108975e9aa6463b9a574de961317e0" name="ga29108975e9aa6463b9a574de961317e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga29108975e9aa6463b9a574de961317e0">&#9670;&#160;</a></span>netifapi_dhcp_inform</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define netifapi_dhcp_inform</td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>n</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><a class="code hl_function" href="netifapi_8h.html#a26fd83042b53b2ff82e15262ed72f0a7">netifapi_netif_common</a>(n, <a class="code hl_function" href="group__dhcp4.html#gabd7fcc7e0799e313885fc7fd9d4992ad">dhcp_inform</a>, NULL)</div>
<div class="ttc" id="agroup__dhcp4_html_gabd7fcc7e0799e313885fc7fd9d4992ad"><div class="ttname"><a href="group__dhcp4.html#gabd7fcc7e0799e313885fc7fd9d4992ad">dhcp_inform</a></div><div class="ttdeci">void dhcp_inform(struct netif *netif)</div><div class="ttdef"><b>Definition</b> dhcp.c:819</div></div>
<div class="ttc" id="anetifapi_8h_html_a26fd83042b53b2ff82e15262ed72f0a7"><div class="ttname"><a href="netifapi_8h.html#a26fd83042b53b2ff82e15262ed72f0a7">netifapi_netif_common</a></div><div class="ttdeci">err_t netifapi_netif_common(struct netif *netif, netifapi_void_fn voidfunc, netifapi_errt_fn errtfunc)</div><div class="ttdef"><b>Definition</b> netifapi.c:303</div></div>
</div><!-- fragment --><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__dhcp4.html#gabd7fcc7e0799e313885fc7fd9d4992ad">dhcp_inform()</a> </dd></dl>
</div>
</div>
<a id="ga5aeaee24c11128df90a56fe091c9d409" name="ga5aeaee24c11128df90a56fe091c9d409"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5aeaee24c11128df90a56fe091c9d409">&#9670;&#160;</a></span>netifapi_dhcp_release</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define netifapi_dhcp_release</td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>n</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><a class="code hl_function" href="netifapi_8h.html#a26fd83042b53b2ff82e15262ed72f0a7">netifapi_netif_common</a>(n, NULL, <a class="code hl_function" href="group__dhcp4.html#gaf92f7afb58252f82a749064602974bd4">dhcp_release</a>)</div>
<div class="ttc" id="agroup__dhcp4_html_gaf92f7afb58252f82a749064602974bd4"><div class="ttname"><a href="group__dhcp4.html#gaf92f7afb58252f82a749064602974bd4">dhcp_release</a></div><div class="ttdeci">err_t dhcp_release(struct netif *netif)</div><div class="ttdef"><b>Definition</b> dhcp.c:1393</div></div>
</div><!-- fragment --><dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000004">Deprecated</a></b></dt><dd>Use <a class="el" href="#ga1971af04f882f5afdb3ade454a680134">netifapi_dhcp_release_and_stop()</a> instead. </dd></dl>
</div>
</div>
<a id="ga1971af04f882f5afdb3ade454a680134" name="ga1971af04f882f5afdb3ade454a680134"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1971af04f882f5afdb3ade454a680134">&#9670;&#160;</a></span>netifapi_dhcp_release_and_stop</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define netifapi_dhcp_release_and_stop</td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>n</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><a class="code hl_function" href="netifapi_8h.html#a26fd83042b53b2ff82e15262ed72f0a7">netifapi_netif_common</a>(n, <a class="code hl_function" href="group__dhcp4.html#gaf7cd42b9f220446b6a597d3474da6ece">dhcp_release_and_stop</a>, NULL)</div>
<div class="ttc" id="agroup__dhcp4_html_gaf7cd42b9f220446b6a597d3474da6ece"><div class="ttname"><a href="group__dhcp4.html#gaf7cd42b9f220446b6a597d3474da6ece">dhcp_release_and_stop</a></div><div class="ttdeci">void dhcp_release_and_stop(struct netif *netif)</div><div class="ttdef"><b>Definition</b> dhcp.c:1316</div></div>
</div><!-- fragment --><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__dhcp4.html#gaf7cd42b9f220446b6a597d3474da6ece">dhcp_release_and_stop()</a> </dd></dl>
</div>
</div>
<a id="ga642390e5efa53ad3095e01331c6a936b" name="ga642390e5efa53ad3095e01331c6a936b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga642390e5efa53ad3095e01331c6a936b">&#9670;&#160;</a></span>netifapi_dhcp_renew</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define netifapi_dhcp_renew</td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>n</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><a class="code hl_function" href="netifapi_8h.html#a26fd83042b53b2ff82e15262ed72f0a7">netifapi_netif_common</a>(n, NULL, <a class="code hl_function" href="group__dhcp4.html#ga583eb8d58f5e96b7dea717948578a947">dhcp_renew</a>)</div>
<div class="ttc" id="agroup__dhcp4_html_ga583eb8d58f5e96b7dea717948578a947"><div class="ttname"><a href="group__dhcp4.html#ga583eb8d58f5e96b7dea717948578a947">dhcp_renew</a></div><div class="ttdeci">err_t dhcp_renew(struct netif *netif)</div><div class="ttdef"><b>Definition</b> dhcp.c:1148</div></div>
</div><!-- fragment --><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__dhcp4.html#ga583eb8d58f5e96b7dea717948578a947">dhcp_renew()</a> </dd></dl>
</div>
</div>
<a id="gae64d13afc6e3b0f21aae04b66d0e3765" name="gae64d13afc6e3b0f21aae04b66d0e3765"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae64d13afc6e3b0f21aae04b66d0e3765">&#9670;&#160;</a></span>netifapi_dhcp_start</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define netifapi_dhcp_start</td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>n</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><a class="code hl_function" href="netifapi_8h.html#a26fd83042b53b2ff82e15262ed72f0a7">netifapi_netif_common</a>(n, NULL, <a class="code hl_function" href="group__dhcp4.html#ga0c50968d9811aa2aa67fadc0885d744f">dhcp_start</a>)</div>
<div class="ttc" id="agroup__dhcp4_html_ga0c50968d9811aa2aa67fadc0885d744f"><div class="ttname"><a href="group__dhcp4.html#ga0c50968d9811aa2aa67fadc0885d744f">dhcp_start</a></div><div class="ttdeci">err_t dhcp_start(struct netif *netif)</div><div class="ttdef"><b>Definition</b> dhcp.c:742</div></div>
</div><!-- fragment --><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__dhcp4.html#ga0c50968d9811aa2aa67fadc0885d744f">dhcp_start()</a> </dd></dl>
</div>
</div>
<a id="ga2322c0d0e3eb6c1097d6f3942905dbd5" name="ga2322c0d0e3eb6c1097d6f3942905dbd5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2322c0d0e3eb6c1097d6f3942905dbd5">&#9670;&#160;</a></span>netifapi_dhcp_stop</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define netifapi_dhcp_stop</td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>n</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><a class="code hl_function" href="netifapi_8h.html#a26fd83042b53b2ff82e15262ed72f0a7">netifapi_netif_common</a>(n, <a class="code hl_function" href="group__dhcp4.html#ga93f6bf21086dc9b10c0bec4676f97312">dhcp_stop</a>, NULL)</div>
<div class="ttc" id="agroup__dhcp4_html_ga93f6bf21086dc9b10c0bec4676f97312"><div class="ttname"><a href="group__dhcp4.html#ga93f6bf21086dc9b10c0bec4676f97312">dhcp_stop</a></div><div class="ttdeci">void dhcp_stop(struct netif *netif)</div><div class="ttdef"><b>Definition</b> dhcp.c:1405</div></div>
</div><!-- fragment --><dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000003">Deprecated</a></b></dt><dd>Use <a class="el" href="#ga1971af04f882f5afdb3ade454a680134">netifapi_dhcp_release_and_stop()</a> instead. </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>