blob: 1f960779d606bd02561c93fa85545c293d800fa8 [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/api/netdb.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('netdb_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="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">netdb.c File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="lwip_2netdb_8h.html">lwip/netdb.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="err_8h.html">lwip/err.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="mem_8h.html">lwip/mem.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="ip__addr_8h.html">lwip/ip_addr.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="api_8h.html">lwip/api.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="dns_8h.html">lwip/dns.h</a>&quot;</code><br />
<code>#include &lt;string.h&gt;</code><br />
<code>#include &lt;stdlib.h&gt;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgethostbyname__r__helper.html">gethostbyname_r_helper</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a768ab8ead892d6454709680340cd070e" id="r_a768ab8ead892d6454709680340cd070e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a768ab8ead892d6454709680340cd070e">LWIP_DNS_API_HOSTENT_STORAGE</a>&#160;&#160;&#160;0</td></tr>
<tr class="separator:a768ab8ead892d6454709680340cd070e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acfc1e988534c0e497599b904739f92fe" id="r_acfc1e988534c0e497599b904739f92fe"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acfc1e988534c0e497599b904739f92fe">HOSTENT_STORAGE</a>&#160;&#160;&#160;static</td></tr>
<tr class="separator:acfc1e988534c0e497599b904739f92fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:abe6a6a103a2f6fa4e13098e455ac7bb3" id="r_abe6a6a103a2f6fa4e13098e455ac7bb3"><td class="memItemLeft" align="right" valign="top">struct hostent *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abe6a6a103a2f6fa4e13098e455ac7bb3">lwip_gethostbyname</a> (const char *name)</td></tr>
<tr class="separator:abe6a6a103a2f6fa4e13098e455ac7bb3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa229e90916f6c8d6308828f45351d2d" id="r_afa229e90916f6c8d6308828f45351d2d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afa229e90916f6c8d6308828f45351d2d">lwip_gethostbyname_r</a> (const char *name, struct hostent *ret, char *buf, size_t buflen, struct hostent **result, int *h_errnop)</td></tr>
<tr class="separator:afa229e90916f6c8d6308828f45351d2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f65ff5982a0743849a644ef2cd15ef5" id="r_a7f65ff5982a0743849a644ef2cd15ef5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7f65ff5982a0743849a644ef2cd15ef5">lwip_freeaddrinfo</a> (struct addrinfo *ai)</td></tr>
<tr class="separator:a7f65ff5982a0743849a644ef2cd15ef5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af356989c172a51187e22b557f22d4165" id="r_af356989c172a51187e22b557f22d4165"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af356989c172a51187e22b557f22d4165">lwip_getaddrinfo</a> (const char *nodename, const char *servname, const struct addrinfo *hints, struct addrinfo **res)</td></tr>
<tr class="separator:af356989c172a51187e22b557f22d4165"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a2a1ce3f2040007303d36c0b682b5ac10" id="r_a2a1ce3f2040007303d36c0b682b5ac10"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2a1ce3f2040007303d36c0b682b5ac10">h_errno</a></td></tr>
<tr class="separator:a2a1ce3f2040007303d36c0b682b5ac10"><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>API functions for name resolving </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="acfc1e988534c0e497599b904739f92fe" name="acfc1e988534c0e497599b904739f92fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acfc1e988534c0e497599b904739f92fe">&#9670;&#160;</a></span>HOSTENT_STORAGE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define HOSTENT_STORAGE&#160;&#160;&#160;static</td>
</tr>
</table>
</div><div class="memdoc">
<p>define "hostent" variables storage </p>
</div>
</div>
<a id="a768ab8ead892d6454709680340cd070e" name="a768ab8ead892d6454709680340cd070e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a768ab8ead892d6454709680340cd070e">&#9670;&#160;</a></span>LWIP_DNS_API_HOSTENT_STORAGE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define LWIP_DNS_API_HOSTENT_STORAGE&#160;&#160;&#160;0</td>
</tr>
</table>
</div><div class="memdoc">
<p>define "hostent" variables storage: 0 if we use a static (but unprotected) set of variables for lwip_gethostbyname, 1 if we use a local storage </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a7f65ff5982a0743849a644ef2cd15ef5" name="a7f65ff5982a0743849a644ef2cd15ef5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f65ff5982a0743849a644ef2cd15ef5">&#9670;&#160;</a></span>lwip_freeaddrinfo()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void lwip_freeaddrinfo </td>
<td>(</td>
<td class="paramtype">struct addrinfo *</td> <td class="paramname"><span class="paramname"><em>ai</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Frees one or more addrinfo structures returned by getaddrinfo(), along with any additional storage associated with those structures. If the ai_next field of the structure is not null, the entire list of structures is freed.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ai</td><td>struct addrinfo to free </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af356989c172a51187e22b557f22d4165" name="af356989c172a51187e22b557f22d4165"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af356989c172a51187e22b557f22d4165">&#9670;&#160;</a></span>lwip_getaddrinfo()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int lwip_getaddrinfo </td>
<td>(</td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>nodename</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>servname</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const struct addrinfo *</td> <td class="paramname"><span class="paramname"><em>hints</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct addrinfo **</td> <td class="paramname"><span class="paramname"><em>res</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Translates the name of a service location (for example, a host name) and/or a service name and returns a set of socket addresses and associated information to be used in creating a socket with which to address the specified service. Memory for the result is allocated internally and must be freed by calling <a class="el" href="#a7f65ff5982a0743849a644ef2cd15ef5">lwip_freeaddrinfo()</a>!</p>
<p>Due to a limitation in dns_gethostbyname, only the first address of a host is returned. Also, service names are not supported (only port numbers)!</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">nodename</td><td>descriptive name or address string of the host (may be NULL -&gt; local address) </td></tr>
<tr><td class="paramname">servname</td><td>port number as string of NULL </td></tr>
<tr><td class="paramname">hints</td><td>structure containing input values that set socktype and protocol </td></tr>
<tr><td class="paramname">res</td><td>pointer to a pointer where to store the result (set to NULL on failure) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, non-zero on failure</dd></dl>
</div>
</div>
<a id="abe6a6a103a2f6fa4e13098e455ac7bb3" name="abe6a6a103a2f6fa4e13098e455ac7bb3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe6a6a103a2f6fa4e13098e455ac7bb3">&#9670;&#160;</a></span>lwip_gethostbyname()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct hostent * lwip_gethostbyname </td>
<td>(</td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an entry containing addresses of address family AF_INET for the host with name name. Due to dns_gethostbyname limitations, only one address is returned.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>the hostname to resolve </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an entry containing addresses of address family AF_INET for the host with name name </dd></dl>
</div>
</div>
<a id="afa229e90916f6c8d6308828f45351d2d" name="afa229e90916f6c8d6308828f45351d2d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afa229e90916f6c8d6308828f45351d2d">&#9670;&#160;</a></span>lwip_gethostbyname_r()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int lwip_gethostbyname_r </td>
<td>(</td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct hostent *</td> <td class="paramname"><span class="paramname"><em>ret</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>buf</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>buflen</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct hostent **</td> <td class="paramname"><span class="paramname"><em>result</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>h_errnop</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Thread-safe variant of lwip_gethostbyname: instead of using a static buffer, this function takes buffer and errno pointers as arguments and uses these for the result.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>the hostname to resolve </td></tr>
<tr><td class="paramname">ret</td><td>pre-allocated struct where to store the result </td></tr>
<tr><td class="paramname">buf</td><td>pre-allocated buffer where to store additional data </td></tr>
<tr><td class="paramname">buflen</td><td>the size of buf </td></tr>
<tr><td class="paramname">result</td><td>pointer to a hostent pointer that is set to ret on success and set to zero on error </td></tr>
<tr><td class="paramname">h_errnop</td><td>pointer to an int where to store errors (instead of modifying the global h_errno) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, non-zero on error, additional error information is stored in *h_errnop instead of h_errno to be thread-safe </dd></dl>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a2a1ce3f2040007303d36c0b682b5ac10" name="a2a1ce3f2040007303d36c0b682b5ac10"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2a1ce3f2040007303d36c0b682b5ac10">&#9670;&#160;</a></span>h_errno</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int h_errno</td>
</tr>
</table>
</div><div class="memdoc">
<p>h_errno is exported in netdb.h for access by applications. </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_da61e3e9a357748887e3ca8d7c5a0c16.html">api</a></li><li class="navelem"><a class="el" href="netdb_8c.html">netdb.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>