lwres_getipnode.html revision ddccd5811feff696ba460dabfb666ce61040f545
fdd80e9a55c70b36a3bf3e409b86897301c44ff8Automatic Updater - Copyright (C) 2000, 2001 Internet Software Consortium.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - Permission to use, copy, modify, and distribute this software for any
4a14ce5ba00ab7bc55c99ffdcf59c7a4ab902721Automatic Updater - purpose with or without fee is hereby granted, provided that the above
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - copyright notice and this permission notice appear in all copies.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - INTERNET SOFTWARE CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>lwres_getipnode</TITLE
e21a2904f02a03fa06b6db04d348f65fe9c67b2bMark AndrewsNAME="GENERATOR"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCONTENT="Modular DocBook HTML Stylesheet Version 1.61
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="REFENTRY"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinBGCOLOR="#FFFFFF"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinTEXT="#000000"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinLINK="#0000FF"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinVLINK="#840084"
71c66a876ecca77923638d3f94cc0783152b2f03Mark AndrewsALINK="#0000FF"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>lwres_getipnode</A
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="REFNAMEDIV"
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews>lwres_getipnodebyname, lwres_getipnodebyaddr, lwres_freehostent -- lightweight resolver nodename / address translation API</DIV
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="REFSYNOPSISDIV"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="FUNCSYNOPSIS"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="FUNCSYNOPSISINFO"
1238b38c9f0ab563b762dc0fd00ac6c34c2b7295Automatic UpdaterCLASS="FUNCDEF"
1238b38c9f0ab563b762dc0fd00ac6c34c2b7295Automatic Updater>struct hostent *
1238b38c9f0ab563b762dc0fd00ac6c34c2b7295Automatic Updaterlwres_getipnodebyname</CODE
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>(const char *name, int af, int flags, int *error_num);</CODE
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="FUNCDEF"
1238b38c9f0ab563b762dc0fd00ac6c34c2b7295Automatic Updater>struct hostent *
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinlwres_getipnodebyaddr</CODE
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>(const void *src, size_t len, int af, int *error_num);</CODE
1238b38c9f0ab563b762dc0fd00ac6c34c2b7295Automatic UpdaterCLASS="FUNCDEF"
44d0f0256fbdce130a18655023c3b06bacacbd61Automatic Updaterlwres_freehostent</CODE
1238b38c9f0ab563b762dc0fd00ac6c34c2b7295Automatic Updater>(struct hostent *he);</CODE
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="REFSECT1"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>DESCRIPTION</H2
1238b38c9f0ab563b762dc0fd00ac6c34c2b7295Automatic Updater>These functions perform thread safe, protocol independent
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinnodename-to-address and address-to-nodename
1238b38c9f0ab563b762dc0fd00ac6c34c2b7295Automatic Updatertranslation as defined in RFC2553.</P
507151045be68c671ffd4e2f37e17cdfa0376fc4Automatic Updater>struct hostent</SPAN
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinwhich is defined in
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="FILENAME"
71c66a876ecca77923638d3f94cc0783152b2f03Mark AndrewsCLASS="PROGRAMLISTING"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>struct hostent {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein char *h_name; /* official name of host */
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews char **h_aliases; /* alias list */
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein int h_addrtype; /* host address type */
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein int h_length; /* length of address */
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews char **h_addr_list; /* list of addresses from name server */
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein#define h_addr h_addr_list[0] /* address, for backward compatibility */</PRE
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>The members of this structure are:
71c66a876ecca77923638d3f94cc0783152b2f03Mark AndrewsCLASS="VARIABLELIST"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="CONSTANT"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>The official (canonical) name of the host.</P
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="CONSTANT"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>h_aliases</TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>A NULL-terminated array of alternate names (nicknames) for the host.</P
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="CONSTANT"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>h_addrtype</TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>The type of address being returned - usually
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>PF_INET</SPAN
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>PF_INET6</SPAN
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark AndrewsCLASS="CONSTANT"
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews>h_length</TT
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews>The length of the address in bytes.</P
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark AndrewsCLASS="CONSTANT"
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews>h_addr_list</TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinterminated array of network addresses for the host.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinHost addresses are returned in network byte order.</P
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="FUNCTION"
afb33f777af856f8c3382604a7a8ffdfe2b512c5Automatic Updater>lwres_getipnodebyname()</TT
afb33f777af856f8c3382604a7a8ffdfe2b512c5Automatic Updaterlooks up addresses of protocol family
afb33f777af856f8c3382604a7a8ffdfe2b512c5Automatic UpdaterCLASS="PARAMETER"
afb33f777af856f8c3382604a7a8ffdfe2b512c5Automatic Updaterfor the hostname
afb33f777af856f8c3382604a7a8ffdfe2b512c5Automatic UpdaterCLASS="PARAMETER"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="PARAMETER"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinparameter contains ORed flag bits to
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinspecify the types of addresses that are searched
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinfor, and the types of addresses that are returned.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinThe flag bits are:
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="VARIABLELIST"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="CONSTANT"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>AI_V4MAPPED</TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>This is used with an
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="PARAMETER"
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrewsof AF_INET6, and causes IPv4 addresses to be returned as IPv4-mapped
ceeb18e6907a10547859faa340ecad83bedae90cMark AndrewsIPv6 addresses.</P
ceeb18e6907a10547859faa340ecad83bedae90cMark AndrewsCLASS="CONSTANT"
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews>This is used with an
ceeb18e6907a10547859faa340ecad83bedae90cMark AndrewsCLASS="PARAMETER"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinof AF_INET6, and causes all known addresses (IPv6 and IPv4) to be returned.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinIf AI_V4MAPPED is also set, the IPv4 addresses are return as mapped
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinIPv6 addresses.</P
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="CONSTANT"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>AI_ADDRCONFIG</TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>Only return an IPv6 or IPv4 address if here is an active network
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeininterface of that type. This is not currently implemented
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinin the BIND 9 lightweight resolver, and the flag is ignored.</P
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="CONSTANT"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>AI_DEFAULT</TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>This default sets the
bea931e17b7567f09107f93ab7e25c7f00abeb9cMark AndrewsCLASS="CONSTANT"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>AI_V4MAPPED</TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="CONSTANT"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>AI_ADDRCONFIG</TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinflag bits.</P
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="FUNCTION"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>lwres_getipnodebyaddr()</TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinperforms a reverse lookup
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="PARAMETER"
ceeb18e6907a10547859faa340ecad83bedae90cMark AndrewsCLASS="PARAMETER"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="PARAMETER"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeindenotes the protocol family, typically
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>PF_INET</SPAN
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>PF_INET6</SPAN
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="FUNCTION"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>lwres_freehostent()</TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinreleases all the memory associated with
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>struct hostent</SPAN
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="PARAMETER"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinAny memory allocated for the
b05bdb520d83f7ecaad708fe305268c3420be01dMark AndrewsCLASS="CONSTANT"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="CONSTANT"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>h_addr_list</TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="CONSTANT"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>h_aliases</TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinis freed, as is the memory for the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>hostent</SPAN
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinstructure itself.</P
984c2e9f76e66e86f7d9aca99a774836ddf196eaAutomatic UpdaterCLASS="REFSECT1"
984c2e9f76e66e86f7d9aca99a774836ddf196eaAutomatic Updater>RETURN VALUES</H2
984c2e9f76e66e86f7d9aca99a774836ddf196eaAutomatic Updater>If an error occurs,
984c2e9f76e66e86f7d9aca99a774836ddf196eaAutomatic UpdaterCLASS="FUNCTION"
984c2e9f76e66e86f7d9aca99a774836ddf196eaAutomatic Updater>lwres_getipnodebyname()</TT
984c2e9f76e66e86f7d9aca99a774836ddf196eaAutomatic UpdaterCLASS="FUNCTION"
984c2e9f76e66e86f7d9aca99a774836ddf196eaAutomatic Updater>lwres_getipnodebyaddr()</TT
984c2e9f76e66e86f7d9aca99a774836ddf196eaAutomatic UpdaterCLASS="PARAMETER"
984c2e9f76e66e86f7d9aca99a774836ddf196eaAutomatic Updaterto an approriate error code and the function returns a
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinThe error codes and their meanings are defined in
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="FILENAME"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="VARIABLELIST"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="CONSTANT"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>HOST_NOT_FOUND</TT
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews>No such host is known.</P
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="CONSTANT"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>NO_ADDRESS</TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>The server recognised the request and the name but no address is
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinavailable. Another type of request to the name server for the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeindomain might return an answer.</P
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="CONSTANT"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>TRY_AGAIN</TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>A temporary and possibly transient error occurred, such as a
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinfailure of a server to respond. The request may succeed if
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="CONSTANT"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>NO_RECOVERY</TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>An unexpected failure occurred, and retrying the request
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinis pointless.</P
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="CITEREFENTRY"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="REFENTRYTITLE"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>lwres_hstrerror</SPAN
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeintranslates these error codes to suitable error messages.</P
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="REFSECT1"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinNAME="AEN149"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>SEE ALSO</H2
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="CITEREFENTRY"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="REFENTRYTITLE"
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce>RFC2553</SPAN
1238b38c9f0ab563b762dc0fd00ac6c34c2b7295Automatic UpdaterCLASS="CITEREFENTRY"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="REFENTRYTITLE"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="CITEREFENTRY"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="REFENTRYTITLE"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>lwres_gethostent</SPAN
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="CITEREFENTRY"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="REFENTRYTITLE"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>lwres_getaddrinfo</SPAN
4556ad3a270bf049b3225433a402666aaffe3c36Mark AndrewsCLASS="CITEREFENTRY"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="REFENTRYTITLE"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>lwres_getnameinfo</SPAN
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="CITEREFENTRY"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="REFENTRYTITLE"
4556ad3a270bf049b3225433a402666aaffe3c36Mark Andrews>lwres_hstrerror</SPAN