58048f4d65802be6132df21aead8377722265ad2
[pspp] / lib / getaddrinfo.h
1 /* Get address information.
2    Copyright (C) 1996-2002, 2003, 2004, 2005, 2006
3                  Free Software Foundation, Inc.
4    Contributed by Simon Josefsson <simon@josefsson.org>.
5
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 2, or (at your option)
9    any later version.
10
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    You should have received a copy of the GNU General Public License
17    along with this program; if not, write to the Free Software Foundation,
18    Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
19
20 #ifndef GETADDRINFO_H
21 #define GETADDRINFO_H
22
23 /* sys/socket.h in i386-unknown-freebsd4.10 and
24    powerpc-apple-darwin5.5 require sys/types.h, so include it first.
25    Then we'll also get 'socklen_t' and 'struct sockaddr' which are
26    used below. */
27 #include <sys/types.h>
28 /* Get all getaddrinfo related declarations, if available.  */
29 #include <sys/socket.h>
30 #ifdef HAVE_NETDB_H
31 # include <netdb.h>
32 #endif
33
34 #ifndef HAVE_STRUCT_ADDRINFO
35
36 /* Structure to contain information about address of a service provider.  */
37 struct addrinfo
38 {
39   int ai_flags;                 /* Input flags.  */
40   int ai_family;                /* Protocol family for socket.  */
41   int ai_socktype;              /* Socket type.  */
42   int ai_protocol;              /* Protocol for socket.  */
43   socklen_t ai_addrlen;         /* Length of socket address.  */
44   struct sockaddr *ai_addr;     /* Socket address for socket.  */
45   char *ai_canonname;           /* Canonical name for service location.  */
46   struct addrinfo *ai_next;     /* Pointer to next in list.  */
47 };
48 #endif
49
50 /* Possible values for `ai_flags' field in `addrinfo' structure.  */
51 #ifndef AI_CANONNAME
52 # define AI_CANONNAME   0x0002  /* Request for canonical name.  */
53 #endif
54 #ifndef AI_NUMERICSERV
55 # define AI_NUMERICSERV 0x0400  /* Don't use name resolution.  */
56 #endif
57 #if 0
58 /* The commented out definitions below are not yet implemented in the
59    GNULIB getaddrinfo() replacement, so are not yet needed and may, in fact,
60    cause conflicts on systems with a getaddrinfo() function which does not
61    define them.
62
63    If they are restored, be sure to protect the definitions with #ifndef.  */
64 #define AI_PASSIVE      0x0001  /* Socket address is intended for `bind'.  */
65 #define AI_NUMERICHOST  0x0004  /* Don't use name resolution.  */
66 #define AI_V4MAPPED     0x0008  /* IPv4 mapped addresses are acceptable.  */
67 #define AI_ALL          0x0010  /* Return IPv4 mapped and IPv6 addresses.  */
68 #define AI_ADDRCONFIG   0x0020  /* Use configuration of this host to choose
69                                    returned address type..  */
70 #endif /* 0 */
71
72 /* Error values for `getaddrinfo' function.  */
73 #ifndef EAI_BADFLAGS
74 # define EAI_BADFLAGS     -1    /* Invalid value for `ai_flags' field.  */
75 # define EAI_NONAME       -2    /* NAME or SERVICE is unknown.  */
76 # define EAI_AGAIN        -3    /* Temporary failure in name resolution.  */
77 # define EAI_FAIL         -4    /* Non-recoverable failure in name res.  */
78 # define EAI_NODATA       -5    /* No address associated with NAME.  */
79 # define EAI_FAMILY       -6    /* `ai_family' not supported.  */
80 # define EAI_SOCKTYPE     -7    /* `ai_socktype' not supported.  */
81 # define EAI_SERVICE      -8    /* SERVICE not supported for `ai_socktype'.  */
82 # define EAI_MEMORY       -10   /* Memory allocation failure.  */
83 #endif
84 #ifndef EAI_OVERFLOW
85 /* Not defined on mingw32. */
86 # define EAI_OVERFLOW     -12   /* Argument buffer overflow.  */
87 #endif
88 #ifndef EAI_ADDRFAMILY
89 /* Not defined on mingw32. */
90 # define EAI_ADDRFAMILY  -9     /* Address family for NAME not supported.  */
91 #endif
92 #ifndef EAI_SYSTEM
93 /* Not defined on mingw32. */
94 # define EAI_SYSTEM       -11   /* System error returned in `errno'.  */
95 #endif
96
97 #ifdef __USE_GNU
98 # ifndef EAI_INPROGRESS
99 #  define EAI_INPROGRESS        -100    /* Processing request in progress.  */
100 #  define EAI_CANCELED          -101    /* Request canceled.  */
101 #  define EAI_NOTCANCELED       -102    /* Request not canceled.  */
102 #  define EAI_ALLDONE           -103    /* All requests done.  */
103 #  define EAI_INTR              -104    /* Interrupted by a signal.  */
104 #  define EAI_IDN_ENCODE        -105    /* IDN encoding failed.  */
105 # endif
106 #endif
107
108 #if !HAVE_DECL_GETADDRINFO
109 /* Translate name of a service location and/or a service name to set of
110    socket addresses.
111    For more details, see the POSIX:2001 specification
112    <http://www.opengroup.org/susv3xsh/getaddrinfo.html>.  */
113 extern int getaddrinfo (const char *restrict nodename,
114                         const char *restrict servname,
115                         const struct addrinfo *restrict hints,
116                         struct addrinfo **restrict res);
117 #endif
118
119 #if !HAVE_DECL_FREEADDRINFO
120 /* Free `addrinfo' structure AI including associated storage.
121    For more details, see the POSIX:2001 specification
122    <http://www.opengroup.org/susv3xsh/getaddrinfo.html>.  */
123 extern void freeaddrinfo (struct addrinfo *ai);
124 #endif
125
126 #if !HAVE_DECL_GAI_STRERROR
127 /* Convert error return from getaddrinfo() to a string.
128    For more details, see the POSIX:2001 specification
129    <http://www.opengroup.org/susv3xsh/gai_strerror.html>.  */
130 extern const char *gai_strerror (int ecode);
131 #endif
132
133 #if !HAVE_DECL_GETNAMEINFO
134 /* Convert socket address to printable node and service names.
135    For more details, see the POSIX:2001 specification
136    <http://www.opengroup.org/susv3xsh/getnameinfo.html>.  */
137 extern int getnameinfo(const struct sockaddr *restrict sa, socklen_t salen,
138                        char *restrict node, socklen_t nodelen,
139                        char *restrict service, socklen_t servicelen,
140                        int flags);
141
142 #endif
143
144 /* Possible flags for getnameinfo.  */
145 #ifndef NI_NUMERICHOST
146 # define NI_NUMERICHOST 1
147 #endif
148 #ifndef NI_NUMERICSERV
149 # define NI_NUMERICSERV 2
150 #endif
151
152 #endif /* GETADDRINFO_H */