lwres_getnameinfo.docbook revision c651f15b30f1dae5cc2f00878fb5da5b3a35a468
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC")
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews - Copyright (C) 2000, 2001 Internet Software Consortium.
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson - Permission to use, copy, modify, and 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.
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - PERFORMANCE OF THIS SOFTWARE.
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<!-- $Id: lwres_getnameinfo.docbook,v 1.5 2005/04/07 03:50:02 marka Exp $ -->
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson</refentryinfo>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson<refentrytitle>lwres_getnameinfo</refentrytitle>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson<refpurpose>lightweight resolver socket address structure to hostname and service name</refpurpose>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson<refsynopsisdiv>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson<funcsynopsisinfo>#include <lwres/netdb.h></funcsynopsisinfo>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson<funcprototype>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson<function>lwres_getnameinfo</function></funcdef>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson<paramdef>const struct sockaddr *sa</paramdef>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson</funcprototype>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson</funcsynopsis>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson</refsynopsisdiv>
86b0285d7e65601645db4090d62ee6cb63abad6cAndreas Gustafsson<para> This function is equivalent to the <citerefentry>
86b0285d7e65601645db4090d62ee6cb63abad6cAndreas Gustafsson<refentrytitle>getnameinfo</refentrytitle><manvolnum>3</manvolnum>
86b0285d7e65601645db4090d62ee6cb63abad6cAndreas Gustafsson</citerefentry> function defined in RFC2133.
86b0285d7e65601645db4090d62ee6cb63abad6cAndreas Gustafsson<function>lwres_getnameinfo()</function> returns the hostname for the
86b0285d7e65601645db4090d62ee6cb63abad6cAndreas Gustafsson<type>struct sockaddr</type> <parameter>sa</parameter> which is
86b0285d7e65601645db4090d62ee6cb63abad6cAndreas Gustafsson<parameter>salen</parameter> bytes long. The hostname is of length
86b0285d7e65601645db4090d62ee6cb63abad6cAndreas Gustafsson<parameter>hostlen</parameter> and is returned via
86b0285d7e65601645db4090d62ee6cb63abad6cAndreas Gustafsson<parameter>*host.</parameter> The maximum length of the hostname is
86b0285d7e65601645db4090d62ee6cb63abad6cAndreas Gustafsson1025 bytes: <constant>NI_MAXHOST</constant>.</para>
86b0285d7e65601645db4090d62ee6cb63abad6cAndreas Gustafsson<para> The name of the service associated with the port number in
86b0285d7e65601645db4090d62ee6cb63abad6cAndreas Gustafsson<parameter>sa</parameter> is returned in <parameter>*serv.</parameter>
86b0285d7e65601645db4090d62ee6cb63abad6cAndreas GustafssonIt is <parameter>servlen</parameter> bytes long. The maximum length
86b0285d7e65601645db4090d62ee6cb63abad6cAndreas Gustafssonof the service name is <constant>NI_MAXSERV</constant> - 32 bytes.
86b0285d7e65601645db4090d62ee6cb63abad6cAndreas Gustafsson<para> The <parameter>flags</parameter> argument sets the following
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson<varlistentry><term><constant>NI_NOFQDN</constant></term>
ddccd5811feff696ba460dabfb666ce61040f545Andreas GustafssonA fully qualified domain name is not required for local hosts.
ddccd5811feff696ba460dabfb666ce61040f545Andreas GustafssonThe local part of the fully qualified domain name is returned instead.
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson<varlistentry><term><constant>NI_NUMERICHOST</constant></term>
ddccd5811feff696ba460dabfb666ce61040f545Andreas GustafssonReturn the address in numeric form, as if calling inet_ntop(),
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafssoninstead of a host name.
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson<varlistentry><term><constant>NI_NAMEREQD</constant></term>
ddccd5811feff696ba460dabfb666ce61040f545Andreas GustafssonA name is required. If the hostname cannot be found in the DNS and
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafssonthis flag is set, a non-zero error code is returned.
ddccd5811feff696ba460dabfb666ce61040f545Andreas GustafssonIf the hostname is not found and the flag is not set, the
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafssonaddress is returned in numeric form.
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson<varlistentry><term><constant>NI_NUMERICSERV</constant></term>
ddccd5811feff696ba460dabfb666ce61040f545Andreas GustafssonThe service name is returned as a digit string representing the port number.
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson<varlistentry><term><constant>NI_DGRAM</constant></term>
ddccd5811feff696ba460dabfb666ce61040f545Andreas GustafssonSpecifies that the service being looked up is a datagram
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafssonservice, and causes getservbyport() to be called with a second
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafssonargument of "udp" instead of its default of "tcp". This is required
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafssonfor the few ports (512-514) that have different services for UDP and
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson</variablelist>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafssonreturns 0 on success or a non-zero error code if an error occurs.
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson</citerefentry>,
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson<refentrytitle>getservbyport</refentrytitle><manvolnum>3</manvolnum>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson</citerefentry>,
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson<refentrytitle>lwres</refentrytitle><manvolnum>3</manvolnum>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson</citerefentry>,
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson<refentrytitle>lwres_getnameinfo</refentrytitle><manvolnum>3</manvolnum>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson</citerefentry>,
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson<refentrytitle>lwres_getnamebyaddr</refentrytitle><manvolnum>3</manvolnum>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson</citerefentry>.
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson<refentrytitle>lwres_net_ntop</refentrytitle><manvolnum>3</manvolnum>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson</citerefentry>.
ddccd5811feff696ba460dabfb666ce61040f545Andreas GustafssonRFC2133 fails to define what the nonzero return values of
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson<refentrytitle>getnameinfo</refentrytitle><manvolnum>3</manvolnum>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson</citerefentry>