lwres_gai_strerror.docbook revision 30eec077db2bdcb6f2a0dc388a3cdde2ede75ec1
d6fa26d0adaec6c910115be34fe7a5a5f402c14fMark Andrews<!--
0b062f4990db5cc6db2fe3398926f71b92a67407Brian Wellington - Copyright (C) 2004, 2005, 2007, 2014, 2015 Internet Systems Consortium, Inc. ("ISC")
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - Copyright (C) 2000, 2001 Internet Software Consortium.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein -
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - Permission to use, copy, modify, and/or distribute this software for any
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - purpose with or without fee is hereby granted, provided that the above
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - copyright notice and this permission notice appear in all copies.
0b062f4990db5cc6db2fe3398926f71b92a67407Brian Wellington -
d6fa26d0adaec6c910115be34fe7a5a5f402c14fMark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - 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,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User - PERFORMANCE OF THIS SOFTWARE.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews-->
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<!-- Converted by db4-upgrade version 1.0 -->
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<refentry xmlns="http://docbook.org/ns/docbook" version="5.0">
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <info>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <date>2007-06-18</date>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </info>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refentryinfo>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <corpname>ISC</corpname>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </refentryinfo>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refmeta>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <refentrytitle>lwres_gai_strerror</refentrytitle>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <manvolnum>3</manvolnum>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <refmiscinfo>BIND9</refmiscinfo>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </refmeta>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <docinfo>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <copyright>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <year>2004</year>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <year>2005</year>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <year>2007</year>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <year>2014</year>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <year>2015</year>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </copyright>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <copyright>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <year>2000</year>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <year>2001</year>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <holder>Internet Software Consortium.</holder>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </copyright>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </docinfo>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <refnamediv>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <refname>lwres_gai_strerror</refname>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <refpurpose>print suitable error string</refpurpose>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </refnamediv>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <refsynopsisdiv>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <funcsynopsis>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<funcsynopsisinfo>#include &lt;lwres/netdb.h&gt;</funcsynopsisinfo>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<funcprototype>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <funcdef>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox Userchar *
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<function>gai_strerror</function></funcdef>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <paramdef>int <parameter>ecode</parameter></paramdef>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </funcprototype>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User</funcsynopsis>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </refsynopsisdiv>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <refsection><info><title>DESCRIPTION</title></info>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <para><function>lwres_gai_strerror()</function>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User returns an error message corresponding to an error code returned by
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <function>getaddrinfo()</function>.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User The following error codes and their meaning are defined in
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <filename>include/lwres/netdb.h</filename>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <variablelist>
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews <varlistentry>
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater <term><errorcode>EAI_ADDRFAMILY</errorcode></term>
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater <listitem>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <para>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User address family for hostname not supported
ad671240d635376dd8681550eebee799d2e3d1fdAutomatic Updater </para>
ad671240d635376dd8681550eebee799d2e3d1fdAutomatic Updater </listitem>
ad671240d635376dd8681550eebee799d2e3d1fdAutomatic Updater </varlistentry>
ad671240d635376dd8681550eebee799d2e3d1fdAutomatic Updater <varlistentry>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <term><errorcode>EAI_AGAIN</errorcode></term>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <listitem>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <para>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User temporary failure in name resolution
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </para>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </listitem>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <term><errorcode>EAI_BADFLAGS</errorcode></term>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <listitem>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <para>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User invalid value for
aaaf8d4f4873d21e55c3ffb4f656203d08339865Mark Andrews <constant>ai_flags</constant>
aaaf8d4f4873d21e55c3ffb4f656203d08339865Mark Andrews </para>
8e821eea5f57ac47a94305aa7ab0c3570d92a311Automatic Updater </listitem>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User </varlistentry>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <varlistentry>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <term><errorcode>EAI_FAIL</errorcode></term>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <listitem>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <para>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User non-recoverable failure in name resolution
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User </para>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User </listitem>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User </varlistentry>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <varlistentry>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <term><errorcode>EAI_FAMILY</errorcode></term>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <listitem>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <para><constant>ai_family</constant> not supported
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User </para>
731cc132f22dbc9e0ecd7035dce314a61076d31bAutomatic Updater </listitem>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User </varlistentry>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <varlistentry>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <term><errorcode>EAI_MEMORY</errorcode></term>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <listitem>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <para>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User memory allocation failure
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </para>
b272d38cc5d24f64c0647a9afb340c21c4b9aaf7Evan Hunt </listitem>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </varlistentry>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <varlistentry>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <term><errorcode>EAI_NODATA</errorcode></term>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <listitem>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <para>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User no address associated with hostname
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User </para>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User </listitem>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User </varlistentry>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <varlistentry>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <term><errorcode>EAI_NONAME</errorcode></term>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <listitem>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <para>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User hostname or servname not provided, or not known
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User </para>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User </listitem>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User </varlistentry>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <varlistentry>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <term><errorcode>EAI_SERVICE</errorcode></term>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <listitem>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <para>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User servname not supported for <constant>ai_socktype</constant>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User </para>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User </listitem>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User </varlistentry>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <varlistentry>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <term><errorcode>EAI_SOCKTYPE</errorcode></term>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <listitem>
2f8d63983c297c62630044d28a6f66676b4d339dMark Andrews <para><constant>ai_socktype</constant> not supported
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </para>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </listitem>
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater </varlistentry>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <varlistentry>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <term><errorcode>EAI_SYSTEM</errorcode></term>
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater <listitem>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <para>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User system error returned in errno
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User </para>
aaaf8d4f4873d21e55c3ffb4f656203d08339865Mark Andrews </listitem>
8e821eea5f57ac47a94305aa7ab0c3570d92a311Automatic Updater </varlistentry>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </variablelist>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User The message <errorname>invalid error code</errorname> is returned if
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater <parameter>ecode</parameter>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User is out of range.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </para>
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater <para><constant>ai_flags</constant>,
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <constant>ai_family</constant>
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater and
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater <constant>ai_socktype</constant>
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater are elements of the
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater <type>struct addrinfo</type>
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater used by
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <function>lwres_getaddrinfo()</function>.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </para>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </refsection>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <refsection><info><title>SEE ALSO</title></info>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <para><citerefentry>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <refentrytitle>strerror</refentrytitle><manvolnum>3</manvolnum>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </citerefentry>,
8ec3c085233cedb22b05da36e2773c8f357a7e45Automatic Updater
6ea2385360e9e2167e65f9286447da9eea189457Tinderbox User <citerefentry>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <refentrytitle>lwres_getaddrinfo</refentrytitle><manvolnum>3</manvolnum>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User </citerefentry>,
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <citerefentry>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <refentrytitle>getaddrinfo</refentrytitle><manvolnum>3</manvolnum>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User </citerefentry>,
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <citerefentry>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User <refentrytitle>RFC2133</refentrytitle>
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User </citerefentry>.
e62b9c9ce6413fb183c8116381e75dcd07ca5517Tinderbox User </para>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </refsection>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</refentry>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User