1 /* Get address information.
2 Copyright (C) 1996-2002, 2003, 2004, 2005 Free Software Foundation, Inc.
3 Contributed by Simon Josefsson <simon@josefsson.org>.
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2, or (at your option)
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software Foundation,
17 Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
20 # define GETADDRINFO_H
22 /* Get all getaddrinfo related declarations, if available. */
23 # ifdef HAVE_SYS_TYPES_H
24 /* sys/socket.h in i386-unknown-freebsd4.10 and
25 powerpc-apple-darwin5.5 require sys/types.h, so include it first.
26 Then we'll also get 'socklen_t' and 'struct sockaddr' which are
28 # include <sys/types.h>
30 # ifdef HAVE_SYS_SOCKET_H
31 # include <sys/socket.h>
37 # ifndef HAVE_STRUCT_ADDRINFO
39 /* Structure to contain information about address of a service provider. */
42 int ai_flags; /* Input flags. */
43 int ai_family; /* Protocol family for socket. */
44 int ai_socktype; /* Socket type. */
45 int ai_protocol; /* Protocol for socket. */
46 socklen_t ai_addrlen; /* Length of socket address. */
47 struct sockaddr *ai_addr; /* Socket address for socket. */
48 char *ai_canonname; /* Canonical name for service location. */
49 struct addrinfo *ai_next; /* Pointer to next in list. */
53 /* Possible values for `ai_flags' field in `addrinfo' structure. */
55 # define AI_PASSIVE 0x0001 /* Socket address is intended for `bind'. */
56 # define AI_CANONNAME 0x0002 /* Request for canonical name. */
57 # define AI_NUMERICHOST 0x0004 /* Don't use name resolution. */
58 # define AI_V4MAPPED 0x0008 /* IPv4 mapped addresses are acceptable. */
59 # define AI_ALL 0x0010 /* Return IPv4 mapped and IPv6 addresses. */
60 # define AI_ADDRCONFIG 0x0020 /* Use configuration of this host to choose
61 returned address type.. */
64 /* Error values for `getaddrinfo' function. */
66 # define EAI_BADFLAGS -1 /* Invalid value for `ai_flags' field. */
67 # define EAI_NONAME -2 /* NAME or SERVICE is unknown. */
68 # define EAI_AGAIN -3 /* Temporary failure in name resolution. */
69 # define EAI_FAIL -4 /* Non-recoverable failure in name res. */
70 # define EAI_NODATA -5 /* No address associated with NAME. */
71 # define EAI_FAMILY -6 /* `ai_family' not supported. */
72 # define EAI_SOCKTYPE -7 /* `ai_socktype' not supported. */
73 # define EAI_SERVICE -8 /* SERVICE not supported for `ai_socktype'. */
74 # define EAI_ADDRFAMILY -9 /* Address family for NAME not supported. */
75 # define EAI_MEMORY -10 /* Memory allocation failure. */
76 # define EAI_SYSTEM -11 /* System error returned in `errno'. */
77 # define EAI_OVERFLOW -12 /* Argument buffer overflow. */
81 # ifndef EAI_INPROGRESS
82 # define EAI_INPROGRESS -100 /* Processing request in progress. */
83 # define EAI_CANCELED -101 /* Request canceled. */
84 # define EAI_NOTCANCELED -102 /* Request not canceled. */
85 # define EAI_ALLDONE -103 /* All requests done. */
86 # define EAI_INTR -104 /* Interrupted by a signal. */
87 # define EAI_IDN_ENCODE -105 /* IDN encoding failed. */
91 # ifndef HAVE_DECL_GETADDRINFO
92 /* Translate name of a service location and/or a service name to set of
94 For more details, see the POSIX:2001 specification
95 <http://www.opengroup.org/susv3xsh/getaddrinfo.html>. */
96 extern int getaddrinfo (const char *restrict nodename,
97 const char *restrict servname,
98 const struct addrinfo *restrict hints,
99 struct addrinfo **restrict res);
102 # ifndef HAVE_DECL_FREEADDRINFO
103 /* Free `addrinfo' structure AI including associated storage.
104 For more details, see the POSIX:2001 specification
105 <http://www.opengroup.org/susv3xsh/getaddrinfo.html>. */
106 extern void freeaddrinfo (struct addrinfo *ai);
109 # ifndef HAVE_DECL_GAI_STRERROR
110 /* Convert error return from getaddrinfo() to a string.
111 For more details, see the POSIX:2001 specification
112 <http://www.opengroup.org/susv3xsh/gai_strerror.html>. */
113 extern const char *gai_strerror (int ecode);
116 #endif /* GETADDRINFO_H */