lwres_getaddrinfo.html revision d4ef65050feac78554addf6e16a06c6e2e0bd331
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk - Copyright (C) 2001 Internet Software Consortium.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk - Permission to use, copy, modify, and distribute this software for any
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk - purpose with or without fee is hereby granted, provided that the above
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk - copyright notice and this permission notice appear in all copies.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk - THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk - DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk - IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk - INTERNET SOFTWARE CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT,
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk - FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk - NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk - WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk<!-- $Id: lwres_getaddrinfo.html,v 1.2 2001/04/10 21:51:38 bwelling Exp $ -->
dff2cc5646d4437ab9e0cb1dcb59da65462a5938jeff.schenk>lwres_getaddrinfo</TITLE
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkNAME="GENERATOR"
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkCONTENT="Modular DocBook HTML Stylesheet Version 1.61
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkCLASS="REFENTRY"
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkBGCOLOR="#FFFFFF"
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkTEXT="#000000"
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkLINK="#0000FF"
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkVLINK="#840084"
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkALINK="#0000FF"
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk>lwres_getaddrinfo</A
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkCLASS="REFNAMEDIV"
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk>lwres_getaddrinfo, lwres_freeaddrinfo -- socket address structure to host and service name</DIV
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkCLASS="REFSYNOPSISDIV"
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk>Synopsis</H2
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkCLASS="FUNCSYNOPSIS"
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkCLASS="FUNCSYNOPSISINFO"
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkCLASS="FUNCDEF"
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenklwres_getaddrinfo</CODE
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk>(const char *hostname, const char *servname, const struct addrinfo *hints, struct addrinfo **res);</CODE
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkCLASS="FUNCDEF"
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenklwres_freeaddrinfo</CODE
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk>(struct addrinfo *ai);</CODE
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk>If the operating system does not provide a
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk>struct addrinfo</SPAN
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkthe following structure is used:
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkCLASS="PROGRAMLISTING"
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk>struct addrinfo {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk int ai_flags; /* AI_PASSIVE, AI_CANONNAME */
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk int ai_family; /* PF_xxx */
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk int ai_socktype; /* SOCK_xxx */
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk int ai_protocol; /* 0 or IPPROTO_xxx for IPv4 and IPv6 */
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk size_t ai_addrlen; /* length of ai_addr */
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk char *ai_canonname; /* canonical name for hostname */
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk struct sockaddr *ai_addr; /* binary address */
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk struct addrinfo *ai_next; /* next structure in linked list */
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkCLASS="REFSECT1"
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk>DESCRIPTION</H2
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkCLASS="FUNCTION"
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk>lwres_getaddrinfo()</TT
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkis used to get a list of IP addresses and port numbers for host
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkCLASS="PARAMETER"
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkCLASS="PARAMETER"
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkThe function is the lightweight resolver's implementation of
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkCLASS="FUNCTION"
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk>getaddrinfo()</TT
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkas defined in RFC2133.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkCLASS="PARAMETER"
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkCLASS="PARAMETER"
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkare pointers to null-terminated
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkCLASS="PARAMETER"
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkis either a host name or a numeric host address string: a dotted decimal
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkIPv4 address or an IPv6 address.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkCLASS="PARAMETER"
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkis either a decimal port number or a service name as listed in
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkCLASS="FILENAME"
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkCLASS="PARAMETER"
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkis an optional pointer to a
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk>struct addrinfo</SPAN
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkThis structure can be used to provide hints concerning the type of socket
dff2cc5646d4437ab9e0cb1dcb59da65462a5938jeff.schenkthat the caller supports or wishes to use.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkThe caller can supply the following structure elements in
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkCLASS="PARAMETER"
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkCLASS="VARIABLELIST"
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkCLASS="CONSTANT"
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk>ai_family</TT
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk>The protocol family that should be used.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkCLASS="CONSTANT"
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk>ai_family</TT
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk>PF_UNSPEC</SPAN
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkit means the caller will accept any protocol family supported by the
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkoperating system.</P
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkCLASS="CONSTANT"
dff2cc5646d4437ab9e0cb1dcb59da65462a5938jeff.schenk>ai_socktype</TT
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk>denotes the type of socket —
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk>SOCK_STREAM</SPAN
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk>SOCK_DGRAM</SPAN
dff2cc5646d4437ab9e0cb1dcb59da65462a5938jeff.schenk>SOCK_RAW</SPAN
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk— that is wanted.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkCLASS="CONSTANT"
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk>ai_socktype</TT
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkis zero the caller will accept any socket type.</P
dff2cc5646d4437ab9e0cb1dcb59da65462a5938jeff.schenkCLASS="CONSTANT"
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk>ai_protocol</TT
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk>indicates which transport protocol is wanted: IPPROTO_UDP or
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkCLASS="CONSTANT"