Ruby  2.5.0dev(2017-10-22revision60238)
addrinfo.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 1995, 1996, 1997, 1998, and 1999 WIDE Project.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the project nor the names of its contributors
14  * may be used to endorse or promote products derived from this software
15  * without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 
30 #ifndef ADDR_INFO_H
31 #define ADDR_INFO_H
32 
33 /* special compatibility hack */
34 #undef EAI_ADDRFAMILY
35 #undef EAI_AGAIN
36 #undef EAI_BADFLAGS
37 #undef EAI_FAIL
38 #undef EAI_FAMILY
39 #undef EAI_MEMORY
40 #undef EAI_NODATA
41 #undef EAI_NONAME
42 #undef EAI_SERVICE
43 #undef EAI_SOCKTYPE
44 #undef EAI_SYSTEM
45 #undef EAI_BADHINTS
46 #undef EAI_PROTOCOL
47 #undef EAI_MAX
48 
49 #undef AI_PASSIVE
50 #undef AI_CANONNAME
51 #undef AI_NUMERICHOST
52 #undef AI_NUMERICSERV
53 #undef AI_ALL
54 #undef AI_ADDRCONFIG
55 #undef AI_V4MAPPED
56 #undef AI_DEFAULT
57 
58 #undef NI_NOFQDN
59 #undef NI_NUMERICHOST
60 #undef NI_NAMEREQD
61 #undef NI_NUMERICSERV
62 #undef NI_DGRAM
63 
64 #ifndef __P
65 # ifdef HAVE_PROTOTYPES
66 # define __P(args) args
67 # else
68 # define __P(args) ()
69 # endif
70 #endif
71 
72 /* special compatibility hack -- end*/
73 
74 
75 /*
76  * Error return codes from getaddrinfo()
77  */
78 #define EAI_ADDRFAMILY 1 /* address family for hostname not supported */
79 #define EAI_AGAIN 2 /* temporary failure in name resolution */
80 #define EAI_BADFLAGS 3 /* invalid value for ai_flags */
81 #define EAI_FAIL 4 /* non-recoverable failure in name resolution */
82 #define EAI_FAMILY 5 /* ai_family not supported */
83 #define EAI_MEMORY 6 /* memory allocation failure */
84 #define EAI_NODATA 7 /* no address associated with hostname */
85 #define EAI_NONAME 8 /* hostname nor servname provided, or not known */
86 #define EAI_SERVICE 9 /* servname not supported for ai_socktype */
87 #define EAI_SOCKTYPE 10 /* ai_socktype not supported */
88 #define EAI_SYSTEM 11 /* system error returned in errno */
89 #define EAI_BADHINTS 12
90 #define EAI_PROTOCOL 13
91 #define EAI_MAX 14
92 
93 /*
94  * Flag values for getaddrinfo()
95  */
96 #define AI_PASSIVE 0x00000001 /* get address to use bind() */
97 #define AI_CANONNAME 0x00000002 /* fill ai_canonname */
98 #define AI_NUMERICHOST 0x00000004 /* prevent name resolution */
99 #define AI_NUMERICSERV 0x00000008 /* prevent service name resolution */
100 /* valid flags for addrinfo */
101 #ifndef __HAIKU__
102 #undef AI_MASK
103 #define AI_MASK (AI_PASSIVE | AI_CANONNAME | AI_NUMERICHOST | AI_NUMERICSERV)
104 #endif
105 
106 #define AI_ALL 0x00000100 /* IPv6 and IPv4-mapped (with AI_V4MAPPED) */
107 #define AI_V4MAPPED_CFG 0x00000200 /* accept IPv4-mapped if kernel supports */
108 #define AI_ADDRCONFIG 0x00000400 /* only if any address is assigned */
109 #define AI_V4MAPPED 0x00000800 /* accept IPv4-mapped IPv6 address */
110 /* special recommended flags for getipnodebyname */
111 #define AI_DEFAULT (AI_V4MAPPED_CFG | AI_ADDRCONFIG)
112 
113 /*
114  * Constants for getnameinfo()
115  */
116 #ifndef NI_MAXHOST
117 #define NI_MAXHOST 1025
118 #define NI_MAXSERV 32
119 #endif
120 
121 /*
122  * Flag values for getnameinfo()
123  */
124 #define NI_NOFQDN 0x00000001
125 #define NI_NUMERICHOST 0x00000002
126 #define NI_NAMEREQD 0x00000004
127 #define NI_NUMERICSERV 0x00000008
128 #define NI_DGRAM 0x00000010
129 
130 #ifndef HAVE_TYPE_STRUCT_ADDRINFO
131 struct addrinfo {
132  int ai_flags; /* AI_PASSIVE, AI_CANONNAME */
133  int ai_family; /* PF_xxx */
134  int ai_socktype; /* SOCK_xxx */
135  int ai_protocol; /* 0 or IPPROTO_xxx for IPv4 and IPv6 */
136  size_t ai_addrlen; /* length of ai_addr */
137  char *ai_canonname; /* canonical name for hostname */
138  struct sockaddr *ai_addr; /* binary address */
139  struct addrinfo *ai_next; /* next structure in linked list */
140 };
141 #endif
142 
143 #ifndef HAVE_GETADDRINFO
144 #undef getaddrinfo
145 #define getaddrinfo getaddrinfo__compat
146 #endif
147 #ifndef HAVE_GETNAMEINFO
148 #undef getnameinfo
149 #define getnameinfo getnameinfo__compat
150 #endif
151 #ifndef HAVE_FREEHOSTENT
152 #undef freehostent
153 #define freehostent freehostent__compat
154 #endif
155 #ifndef HAVE_FREEADDRINFO
156 #undef freeaddrinfo
157 #define freeaddrinfo freeaddrinfo__compat
158 #endif
159 
160 extern int getaddrinfo __P((
161  const char *hostname, const char *servname,
162  const struct addrinfo *hints,
163  struct addrinfo **res));
164 
165 extern int getnameinfo __P((
166  const struct sockaddr *sa,
167  socklen_t salen,
168  char *host,
169  socklen_t hostlen,
170  char *serv,
171  socklen_t servlen,
172  int flags));
173 
174 extern void freehostent __P((struct hostent *));
175 extern void freeaddrinfo __P((struct addrinfo *));
176 extern
177 #ifdef GAI_STRERROR_CONST
178 const
179 #endif
180 char *gai_strerror __P((int));
181 
182 /* In case there is no definition of offsetof() provided - though any proper
183 Standard C system should have one. */
184 
185 #ifndef offsetof
186 #define offsetof(p_type,field) ((size_t)&(((p_type *)0)->field))
187 #endif
188 
189 #endif
#define freeaddrinfo
Definition: addrinfo.h:157
#define freehostent
Definition: addrinfo.h:153
#define getaddrinfo
Definition: addrinfo.h:145
#define __P(args)
Definition: addrinfo.h:68
char * ai_canonname
Definition: addrinfo.h:137
char * gai_strerror(int ecode)
Definition: getaddrinfo.c:205
int socklen_t
Definition: getaddrinfo.c:83
#define getnameinfo
Definition: addrinfo.h:149
int ai_protocol
Definition: addrinfo.h:135
int ai_socktype
Definition: addrinfo.h:134
struct addrinfo * ai_next
Definition: addrinfo.h:139
size_t ai_addrlen
Definition: addrinfo.h:136
int ai_flags
Definition: addrinfo.h:132
struct sockaddr * ai_addr
Definition: addrinfo.h:138
int ai_family
Definition: addrinfo.h:133