![[bottom]](../icons/bottom.png){kind=icon}
![[previous]](../icons/n_left.png){kind=icon}
![[next]](../icons/n_right.png){kind=icon}
![[first]](../icons/n_first.png){kind=icon}
![[last]](../icons/n_last.png){kind=icon}
![[top]](../icons/n_top.png){kind=icon}
![[index]](../icons/index.png){kind=icon}
![[help]](../icons/help.png){kind=icon}
*/
1 /* Provide a netdb.h header file for systems lacking it (read: MinGW).
2 Copyright (C) 2008-2021 Free Software Foundation, Inc.
3 Written by Simon Josefsson.
4
5 This file is free software: you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as
7 published by the Free Software Foundation; either version 2.1 of the
8 License, or (at your option) any later version.
9
10 This file 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 Lesser General Public License for more details.
14
15 You should have received a copy of the GNU Lesser General Public License
16 along with this program. If not, see <https://www.gnu.org/licenses/>. */
17
18 /* This file is supposed to be used on platforms that lack <netdb.h>.
19 It is intended to provide definitions and prototypes needed by an
20 application. */
21
22 #ifndef _@GUARD_PREFIX@_NETDB_H
23
24 #if __GNUC__ >= 3
25 @PRAGMA_SYSTEM_HEADER@
26 #endif
27 @PRAGMA_COLUMNS@
28
29 #if @HAVE_NETDB_H@
30
31 /* The include_next requires a split double-inclusion guard. */
32 # @INCLUDE_NEXT@ @NEXT_NETDB_H@
33
34 #endif
35
36 #ifndef _@GUARD_PREFIX@_NETDB_H
37 #define _@GUARD_PREFIX@_NETDB_H
38
39 /* Get <netdb.h> definitions such as 'socklen_t' on IRIX 6.5 and OSF/1 4.0 and
40 'struct hostent' on MinGW. */
41 #include <sys/socket.h>
42
43 /* The definitions of _GL_FUNCDECL_RPL etc. are copied here. */
44
45 /* The definition of _GL_ARG_NONNULL is copied here. */
46
47 /* The definition of _GL_WARN_ON_USE is copied here. */
48
49 /* Declarations for a platform that lacks <netdb.h>, or where it is
50 incomplete. */
51
52 #if @GNULIB_GETADDRINFO@
53
54 # if !@HAVE_STRUCT_ADDRINFO@
55
56 # ifdef __cplusplus
57 extern "C" {
58 # endif
59
60 # if !GNULIB_defined_struct_addrinfo
61 /* Structure to contain information about address of a service provider. */
62 struct addrinfo
63 {
64 int ai_flags; /* Input flags. */
65 int ai_family; /* Protocol family for socket. */
66 int ai_socktype; /* Socket type. */
67 int ai_protocol; /* Protocol for socket. */
68 socklen_t ai_addrlen; /* Length of socket address. */
69 struct sockaddr *ai_addr; /* Socket address for socket. */
70 char *ai_canonname; /* Canonical name for service location. */
71 struct addrinfo *ai_next; /* Pointer to next in list. */
72 };
73 # define GNULIB_defined_struct_addrinfo 1
74 # endif
75
76 # ifdef __cplusplus
77 }
78 # endif
79
80 # endif
81
82 /* Possible values for 'ai_flags' field in 'addrinfo' structure. */
83 # ifndef AI_PASSIVE
84 # define AI_PASSIVE 0x0001 /* Socket address is intended for 'bind'. */
85 # endif
86 # ifndef AI_CANONNAME
87 # define AI_CANONNAME 0x0002 /* Request for canonical name. */
88 # endif
89 # ifndef AI_NUMERICSERV
90 # define AI_NUMERICSERV 0x0400 /* Don't use name resolution. */
91 # endif
92
93 # if 0
94 # define AI_NUMERICHOST 0x0004 /* Don't use name resolution. */
95 # endif
96
97 /* These symbolic constants are required to be present by POSIX, but
98 our getaddrinfo replacement doesn't use them (yet). Setting them
99 to 0 on systems that doesn't have them avoids causing problems for
100 system getaddrinfo implementations that would be confused by
101 unknown values. */
102 # ifndef AI_V4MAPPED
103 # define AI_V4MAPPED 0 /* 0x0008: IPv4 mapped addresses are acceptable. */
104 # endif
105 # ifndef AI_ALL
106 # define AI_ALL 0 /* 0x0010: Return IPv4 mapped and IPv6 addresses. */
107 # endif
108 # ifndef AI_ADDRCONFIG
109 # define AI_ADDRCONFIG 0 /* 0x0020: Use configuration of this host to choose
110 returned address type. */
111 # endif
112
113 /* Error values for 'getaddrinfo' function. */
114 # ifndef EAI_BADFLAGS
115 # define EAI_BADFLAGS -1 /* Invalid value for 'ai_flags' field. */
116 # define EAI_NONAME -2 /* NAME or SERVICE is unknown. */
117 # define EAI_AGAIN -3 /* Temporary failure in name resolution. */
118 # define EAI_FAIL -4 /* Non-recoverable failure in name res. */
119 # define EAI_NODATA -5 /* No address associated with NAME. */
120 # define EAI_FAMILY -6 /* 'ai_family' not supported. */
121 # define EAI_SOCKTYPE -7 /* 'ai_socktype' not supported. */
122 # define EAI_SERVICE -8 /* SERVICE not supported for 'ai_socktype'. */
123 # define EAI_MEMORY -10 /* Memory allocation failure. */
124 # endif
125
126 /* Since EAI_NODATA is deprecated by RFC3493, some systems (at least
127 FreeBSD, which does define EAI_BADFLAGS) have removed the definition
128 in favor of EAI_NONAME. */
129 # if !defined EAI_NODATA && defined EAI_NONAME
130 # define EAI_NODATA EAI_NONAME
131 # endif
132
133 # ifndef EAI_OVERFLOW
134 /* Not defined on mingw32 and Haiku. */
135 # define EAI_OVERFLOW -12 /* Argument buffer overflow. */
136 # endif
137 # ifndef EAI_ADDRFAMILY
138 /* Not defined on mingw32. */
139 # define EAI_ADDRFAMILY -9 /* Address family for NAME not supported. */
140 # endif
141 # ifndef EAI_SYSTEM
142 /* Not defined on mingw32. */
143 # define EAI_SYSTEM -11 /* System error returned in 'errno'. */
144 # endif
145
146 # if 0
147 /* The commented out definitions below are not yet implemented in the
148 GNULIB getaddrinfo() replacement, so are not yet needed.
149
150 If they are restored, be sure to protect the definitions with #ifndef. */
151 # ifndef EAI_INPROGRESS
152 # define EAI_INPROGRESS -100 /* Processing request in progress. */
153 # define EAI_CANCELED -101 /* Request canceled. */
154 # define EAI_NOTCANCELED -102 /* Request not canceled. */
155 # define EAI_ALLDONE -103 /* All requests done. */
156 # define EAI_INTR -104 /* Interrupted by a signal. */
157 # define EAI_IDN_ENCODE -105 /* IDN encoding failed. */
158 # endif
159 # endif
160
161 /* Translate name of a service location and/or a service name to set of
162 socket addresses.
163 For more details, see the POSIX:2008 specification
164 <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getaddrinfo.html>. */
165 # if @REPLACE_GETADDRINFO@
166 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
167 # undef getaddrinfo
168 # define getaddrinfo rpl_getaddrinfo
169 # endif
170 _GL_FUNCDECL_RPL (getaddrinfo, int,
171 (const char *restrict nodename,
172 const char *restrict servname,
173 const struct addrinfo *restrict hints,
174 struct addrinfo **restrict res)
175 _GL_ARG_NONNULL ((4)));
176 _GL_CXXALIAS_RPL (getaddrinfo, int,
177 (const char *restrict nodename,
178 const char *restrict servname,
179 const struct addrinfo *restrict hints,
180 struct addrinfo **restrict res));
181 # else
182 # if !@HAVE_DECL_GETADDRINFO@
183 _GL_FUNCDECL_SYS (getaddrinfo, int,
184 (const char *restrict nodename,
185 const char *restrict servname,
186 const struct addrinfo *restrict hints,
187 struct addrinfo **restrict res)
188 _GL_ARG_NONNULL ((4)));
189 # endif
190 _GL_CXXALIAS_SYS (getaddrinfo, int,
191 (const char *restrict nodename,
192 const char *restrict servname,
193 const struct addrinfo *restrict hints,
194 struct addrinfo **restrict res));
195 # endif
196 _GL_CXXALIASWARN (getaddrinfo);
197
198 /* Free 'addrinfo' structure AI including associated storage.
199 For more details, see the POSIX:2008 specification
200 <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getaddrinfo.html>. */
201 # if @REPLACE_GETADDRINFO@
202 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
203 # undef freeaddrinfo
204 # define freeaddrinfo rpl_freeaddrinfo
205 # endif
206 _GL_FUNCDECL_RPL (freeaddrinfo, void, (struct addrinfo *ai)
207 _GL_ARG_NONNULL ((1)));
208 _GL_CXXALIAS_RPL (freeaddrinfo, void, (struct addrinfo *ai));
209 # else
210 # if !@HAVE_DECL_FREEADDRINFO@
211 _GL_FUNCDECL_SYS (freeaddrinfo, void, (struct addrinfo *ai)
212 _GL_ARG_NONNULL ((1)));
213 # endif
214 _GL_CXXALIAS_SYS (freeaddrinfo, void, (struct addrinfo *ai));
215 # endif
216 _GL_CXXALIASWARN (freeaddrinfo);
217
218 # if @REPLACE_GAI_STRERROR@
219 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
220 # undef gai_strerror
221 # define gai_strerror rpl_gai_strerror
222 # endif
223 _GL_FUNCDECL_RPL (gai_strerror, const char *, (int ecode));
224 _GL_CXXALIAS_RPL (gai_strerror, const char *, (int ecode));
225 # else
226 # if !@HAVE_DECL_GAI_STRERROR@
227 /* Convert error return from getaddrinfo() to a string.
228 For more details, see the POSIX:2008 specification
229 <https://pubs.opengroup.org/onlinepubs/9699919799/functions/gai_strerror.html>. */
230 _GL_FUNCDECL_SYS (gai_strerror, const char *, (int ecode));
231 # endif
232 _GL_CXXALIAS_SYS (gai_strerror, const char *, (int ecode));
233 # endif
234 # if __GLIBC__ >= 2
235 _GL_CXXALIASWARN (gai_strerror);
236 # endif
237
238 # if !@HAVE_DECL_GETNAMEINFO@
239 /* Convert socket address to printable node and service names.
240 For more details, see the POSIX:2008 specification
241 <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getnameinfo.html>. */
242 _GL_FUNCDECL_SYS (getnameinfo, int,
243 (const struct sockaddr *restrict sa, socklen_t salen,
244 char *restrict node, socklen_t nodelen,
245 char *restrict service, socklen_t servicelen,
246 int flags)
247 _GL_ARG_NONNULL ((1)));
248 # endif
249 /* Need to cast, because on glibc systems, the seventh parameter is
250 unsigned int flags. */
251 _GL_CXXALIAS_SYS_CAST (getnameinfo, int,
252 (const struct sockaddr *restrict sa, socklen_t salen,
253 char *restrict node, socklen_t nodelen,
254 char *restrict service, socklen_t servicelen,
255 int flags));
256 _GL_CXXALIASWARN (getnameinfo);
257
258 /* Possible flags for getnameinfo. */
259 # ifndef NI_NUMERICHOST
260 # define NI_NUMERICHOST 1
261 # endif
262 # ifndef NI_NUMERICSERV
263 # define NI_NUMERICSERV 2
264 # endif
265
266 #elif defined GNULIB_POSIXCHECK
267
268 # undef getaddrinfo
269 # if HAVE_RAW_DECL_GETADDRINFO
270 _GL_WARN_ON_USE (getaddrinfo, "getaddrinfo is unportable - "
271 "use gnulib module getaddrinfo for portability");
272 # endif
273
274 # undef freeaddrinfo
275 # if HAVE_RAW_DECL_FREEADDRINFO
276 _GL_WARN_ON_USE (freeaddrinfo, "freeaddrinfo is unportable - "
277 "use gnulib module getaddrinfo for portability");
278 # endif
279
280 # undef gai_strerror
281 # if HAVE_RAW_DECL_GAI_STRERROR
282 _GL_WARN_ON_USE (gai_strerror, "gai_strerror is unportable - "
283 "use gnulib module getaddrinfo for portability");
284 # endif
285
286 # undef getnameinfo
287 # if HAVE_RAW_DECL_GETNAMEINFO
288 _GL_WARN_ON_USE (getnameinfo, "getnameinfo is unportable - "
289 "use gnulib module getaddrinfo for portability");
290 # endif
291
292 #endif
293
294 #endif /* _@GUARD_PREFIX@_NETDB_H */
295 #endif /* _@GUARD_PREFIX@_NETDB_H */
![[top]](../icons/top.png){kind=icon}
![[bottom]](../icons/n_bottom.png){kind=icon}
*/