lib/libares/ares.h

   1 /* $Id: ares.h,v 1.3 2000/09/21 19:15:48 ghudson Exp $ */
   2
   3 /* Copyright 1998 by the Massachusetts Institute of Technology.
   4  *
   5  * Permission to use, copy, modify, and distribute this
   6  * software and its documentation for any purpose and without
   7  * fee is hereby granted, provided that the above copyright
   8  * notice appear in all copies and that both that copyright
   9  * notice and this permission notice appear in supporting
  10  * documentation, and that the name of M.I.T. not be used in
  11  * advertising or publicity pertaining to distribution of the
  12  * software without specific, written prior permission.
  13  * M.I.T. makes no representations about the suitability of
  14  * this software for any purpose.  It is provided "as is"
  15  * without express or implied warranty.
  16  */
  17
  18 #ifndef ARES__H
  19 #define ARES__H
  20
  21 #include <sys/types.h>
  22 #include <netinet/in.h>
  23
  24 #define ARES_SUCCESS            0
  25
  26 /* Server error codes (ARES_ENODATA indicates no relevant answer) */
  27 #define ARES_ENODATA            1
  28 #define ARES_EFORMERR           2
  29 #define ARES_ESERVFAIL          3
  30 #define ARES_ENOTFOUND          4
  31 #define ARES_ENOTIMP            5
  32 #define ARES_EREFUSED           6
  33
  34 /* Locally generated error codes */
  35 #define ARES_EBADQUERY          7
  36 #define ARES_EBADNAME           8
  37 #define ARES_EBADFAMILY         9
  38 #define ARES_EBADRESP           10
  39 #define ARES_ECONNREFUSED       11
  40 #define ARES_ETIMEOUT           12
  41 #define ARES_EOF                13
  42 #define ARES_EFILE              14
  43 #define ARES_ENOMEM             15
  44 #define ARES_EDESTRUCTION       16
  45
  46 /* Flag values */
  47 #define ARES_FLAG_USEVC         (1 << 0)
  48 #define ARES_FLAG_PRIMARY       (1 << 1)
  49 #define ARES_FLAG_IGNTC         (1 << 2)
  50 #define ARES_FLAG_NORECURSE     (1 << 3)
  51 #define ARES_FLAG_STAYOPEN      (1 << 4)
  52 #define ARES_FLAG_NOSEARCH      (1 << 5)
  53 #define ARES_FLAG_NOALIASES     (1 << 6)
  54 #define ARES_FLAG_NOCHECKRESP   (1 << 7)
  55
  56 /* Option mask values */
  57 #define ARES_OPT_FLAGS          (1 << 0)
  58 #define ARES_OPT_TIMEOUT        (1 << 1)
  59 #define ARES_OPT_TRIES          (1 << 2)
  60 #define ARES_OPT_NDOTS          (1 << 3)
  61 #define ARES_OPT_UDP_PORT       (1 << 4)
  62 #define ARES_OPT_TCP_PORT       (1 << 5)
  63 #define ARES_OPT_SERVERS        (1 << 6)
  64 #define ARES_OPT_DOMAINS        (1 << 7)
  65 #define ARES_OPT_LOOKUPS        (1 << 8)
  66
  67 struct ares_options {
  68   int flags;
  69   int timeout;
  70   int tries;
  71   int ndots;
  72   unsigned short udp_port;
  73   unsigned short tcp_port;
  74   struct in_addr *servers;
  75   int nservers;
  76   char **domains;
  77   int ndomains;
  78   char *lookups;
  79 };
  80
  81 struct hostent;
  82 struct timeval;
  83 struct ares_channeldata;
  84 typedef struct ares_channeldata *ares_channel;
  85 typedef void (*ares_callback)(void *arg, int status, unsigned char *abuf,
  86                               int alen);
  87 typedef void (*ares_host_callback)(void *arg, int status,
  88                                    struct hostent *hostent);
  89
  90 int ares_init(ares_channel *channelptr);
  91 int ares_init_options(ares_channel *channelptr, struct ares_options *options,
  92                       int optmask);
  93 void ares_destroy(ares_channel channel);
  94
  95 void ares_send(ares_channel channel, const unsigned char *qbuf, int qlen,
  96                ares_callback callback, void *arg);
  97 void ares_query(ares_channel channel, const char *name, int dnsclass,
  98                 int type, ares_callback callback, void *arg);
  99 void ares_search(ares_channel channel, const char *name, int dnsclass,
 100                  int type, ares_callback callback, void *arg);
 101 void ares_gethostbyname(ares_channel channel, const char *name, int family,
 102                         ares_host_callback callback, void *arg);
 103 void ares_gethostbyaddr(ares_channel channel, const void *addr, int addrlen,
 104                         int family, ares_host_callback callback, void *arg);
 105
 106 int ares_fds(ares_channel channel, fd_set *read_fds, fd_set *write_fds);
 107 struct timeval *ares_timeout(ares_channel channel, struct timeval *maxtv,
 108                              struct timeval *tv);
 109 void ares_process(ares_channel channel, fd_set *read_fds, fd_set *write_fds);
 110
 111 int ares_mkquery(const char *name, int dnsclass, int type, unsigned short id,
 112                  int rd, unsigned char **buf, int *buflen);
 113 int ares_expand_name(const unsigned char *encoded, const unsigned char *abuf,
 114                      int alen, char **s, int *enclen);
 115 int ares_parse_a_reply(const unsigned char *abuf, int alen,
 116                        struct hostent **host);
 117 int ares_parse_ptr_reply(const unsigned char *abuf, int alen, const void *addr,
 118                          int addrlen, int family, struct hostent **host);
 119 void ares_free_string(char *str);
 120 void ares_free_hostent(struct hostent *host);
 121 const char *ares_strerror(int code, char **memptr);
 122 void ares_free_errmem(char *mem);
 123
 124 #endif /* ARES__H */