2005-10-01 Simon Josefsson <jas@extundo.com>
[pspp] / lib / getaddrinfo.h
1 /* Get address information.
2    Copyright (C) 1996-2002, 2003, 2004, 2005 Free Software Foundation, Inc.
3    Contributed by Simon Josefsson <simon@josefsson.org>.
4
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)
8    any later version.
9
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.
14
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.  */
18
19 #ifndef GETADDRINFO_H
20 # define GETADDRINFO_H
21
22 /* Get all getaddrinfo related declarations, if available.  */
23 # ifdef HAVE_SYS_SOCKET_H
24 #  include <sys/socket.h>
25 # endif
26 # ifdef HAVE_NETDB_H
27 #  include <netdb.h>
28 # endif
29
30 # ifndef HAVE_STRUCT_ADDRINFO
31
32 /* Get 'socklen_t', and 'struct sockaddr' via sys/types.h which are
33    used below. */
34 #  ifdef HAVE_SYS_TYPES_H
35 #   include <sys/types.h>
36 #  endif
37
38 /* Structure to contain information about address of a service provider.  */
39 struct addrinfo
40 {
41   int ai_flags;                 /* Input flags.  */
42   int ai_family;                /* Protocol family for socket.  */
43   int ai_socktype;              /* Socket type.  */
44   int ai_protocol;              /* Protocol for socket.  */
45   socklen_t ai_addrlen;         /* Length of socket address.  */
46   struct sockaddr *ai_addr;     /* Socket address for socket.  */
47   char *ai_canonname;           /* Canonical name for service location.  */
48   struct addrinfo *ai_next;     /* Pointer to next in list.  */
49 };
50 # endif
51
52 /* Possible values for `ai_flags' field in `addrinfo' structure.  */
53 # ifndef AI_PASSIVE
54 #  define AI_PASSIVE    0x0001  /* Socket address is intended for `bind'.  */
55 #  define AI_CANONNAME  0x0002  /* Request for canonical name.  */
56 #  define AI_NUMERICHOST 0x0004 /* Don't use name resolution.  */
57 #  define AI_V4MAPPED   0x0008  /* IPv4 mapped addresses are acceptable.  */
58 #  define AI_ALL        0x0010  /* Return IPv4 mapped and IPv6 addresses.  */
59 #  define AI_ADDRCONFIG 0x0020  /* Use configuration of this host to choose
60                                    returned address type..  */
61 # endif
62
63 /* Error values for `getaddrinfo' function.  */
64 # ifndef EAI_BADFLAGS
65 #  define EAI_BADFLAGS    -1    /* Invalid value for `ai_flags' field.  */
66 #  define EAI_NONAME      -2    /* NAME or SERVICE is unknown.  */
67 #  define EAI_AGAIN       -3    /* Temporary failure in name resolution.  */
68 #  define EAI_FAIL        -4    /* Non-recoverable failure in name res.  */
69 #  define EAI_NODATA      -5    /* No address associated with NAME.  */
70 #  define EAI_FAMILY      -6    /* `ai_family' not supported.  */
71 #  define EAI_SOCKTYPE    -7    /* `ai_socktype' not supported.  */
72 #  define EAI_SERVICE     -8    /* SERVICE not supported for `ai_socktype'.  */
73 #  define EAI_ADDRFAMILY  -9    /* Address family for NAME not supported.  */
74 #  define EAI_MEMORY      -10   /* Memory allocation failure.  */
75 #  define EAI_SYSTEM      -11   /* System error returned in `errno'.  */
76 #  define EAI_OVERFLOW    -12   /* Argument buffer overflow.  */
77 # endif
78
79 # ifdef __USE_GNU
80 #  ifndef EAI_INPROGRESS
81 #   define EAI_INPROGRESS       -100    /* Processing request in progress.  */
82 #   define EAI_CANCELED         -101    /* Request canceled.  */
83 #   define EAI_NOTCANCELED      -102    /* Request not canceled.  */
84 #   define EAI_ALLDONE          -103    /* All requests done.  */
85 #   define EAI_INTR             -104    /* Interrupted by a signal.  */
86 #   define EAI_IDN_ENCODE       -105    /* IDN encoding failed.  */
87 #  endif
88 # endif
89
90 # ifndef HAVE_DECL_GETADDRINFO
91 /* Translate name of a service location and/or a service name to set of
92    socket addresses.
93    For more details, see the POSIX:2001 specification
94    <http://www.opengroup.org/susv3xsh/getaddrinfo.html>.  */
95 extern int getaddrinfo (const char *restrict nodename,
96                         const char *restrict servname,
97                         const struct addrinfo *restrict hints,
98                         struct addrinfo **restrict res);
99 # endif
100
101 # ifndef HAVE_DECL_FREEADDRINFO
102 /* Free `addrinfo' structure AI including associated storage.
103    For more details, see the POSIX:2001 specification
104    <http://www.opengroup.org/susv3xsh/getaddrinfo.html>.  */
105 extern void freeaddrinfo (struct addrinfo *ai);
106 # endif
107
108 # ifndef HAVE_DECL_GAI_STRERROR
109 /* Convert error return from getaddrinfo() to a string.
110    For more details, see the POSIX:2001 specification
111    <http://www.opengroup.org/susv3xsh/gai_strerror.html>.  */
112 extern const char *gai_strerror (int ecode);
113 # endif
114
115 #endif /* GETADDRINFO_H */