lwres_getnameinfo.html revision 2eeb74d1cf5355dd98f6d507a10086e16bb08c4b
794b79e6bbc3f5db1ea6ae154d739b9f1ef1a375Tinderbox User - Copyright (C) 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC")
75c0816e8295e180f4bc7f10db3d0d880383bc1cMark Andrews - Copyright (C) 2000, 2001 Internet Software Consortium.
4a14ce5ba00ab7bc55c99ffdcf59c7a4ab902721Automatic Updater - Permission to use, copy, modify, and/or distribute this software for any
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson - purpose with or without fee is hereby granted, provided that the above
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson - copyright notice and this permission notice appear in all copies.
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews - PERFORMANCE OF THIS SOFTWARE.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="lwres_getnameinfo">
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User<a name="idp60804688"></a><div class="titlepage"></div>
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User lwres_getnameinfo
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User — lightweight resolver socket address structure to hostname and
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein service name
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <div class="refsynopsisdiv" title="Synopsis">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<pre class="funcsynopsisinfo">#include <lwres/netdb.h></pre>
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<b class="fsfunc">lwres_getnameinfo</b>(</code></td>
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User<td>const struct sockaddr *<var class="pdparam">sa</var>, </td>
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User<td>size_t <var class="pdparam">salen</var>, </td>
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User<td>char *<var class="pdparam">host</var>, </td>
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User<td>size_t <var class="pdparam">hostlen</var>, </td>
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User<td>char *<var class="pdparam">serv</var>, </td>
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User<td>size_t <var class="pdparam">servlen</var>, </td>
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User<td>int <var class="pdparam">flags</var><code>)</code>;</td>
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User<a name="idp60849488"></a><h2>DESCRIPTION</h2>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein This function is equivalent to the
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <span class="refentrytitle">getnameinfo</span>(3)
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User </span> function defined in RFC2133.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <code class="function">lwres_getnameinfo()</code> returns the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein hostname for the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span class="type">struct sockaddr</span> <em class="parameter"><code>sa</code></em> which
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <em class="parameter"><code>salen</code></em> bytes long. The hostname is of
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <em class="parameter"><code>hostlen</code></em> and is returned via
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <em class="parameter"><code>*host.</code></em> The maximum length of the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 1025 bytes: <code class="constant">NI_MAXHOST</code>.
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <p> The name of the service associated with the port number in
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <em class="parameter"><code>sa</code></em> is returned in <em class="parameter"><code>*serv.</code></em>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein It is <em class="parameter"><code>servlen</code></em> bytes long. The
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein maximum length
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein of the service name is <code class="constant">NI_MAXSERV</code> - 32
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The <em class="parameter"><code>flags</code></em> argument sets the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term"><code class="constant">NI_NOFQDN</code></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein A fully qualified domain name is not required for local hosts.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The local part of the fully qualified domain name is returned
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term"><code class="constant">NI_NUMERICHOST</code></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Return the address in numeric form, as if calling inet_ntop(),
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein instead of a host name.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term"><code class="constant">NI_NAMEREQD</code></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein A name is required. If the hostname cannot be found in the DNS
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein this flag is set, a non-zero error code is returned.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein If the hostname is not found and the flag is not set, the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein address is returned in numeric form.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term"><code class="constant">NI_NUMERICSERV</code></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The service name is returned as a digit string representing the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein port number.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term"><code class="constant">NI_DGRAM</code></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Specifies that the service being looked up is a datagram
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein service, and causes getservbyport() to be called with a second
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein argument of "udp" instead of its default of "tcp". This is
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein for the few ports (512-514) that have different services for UDP
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <div class="refsection" title="RETURN VALUES">
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User<a name="idp60870480"></a><h2>RETURN VALUES</h2>
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <p><code class="function">lwres_getnameinfo()</code>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein returns 0 on success or a non-zero error code if an error occurs.
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <span class="refentrytitle">getservbyport</span>(3)
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <span class="refentrytitle">lwres_getnameinfo</span>(3)
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <span class="refentrytitle">lwres_getnamebyaddr</span>(3)
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <span class="refentrytitle">lwres_net_ntop</span>(3)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein RFC2133 fails to define what the nonzero return values of
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <span class="refentrytitle">getnameinfo</span>(3)