lib/getaddrinfo.h

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