removed tabs and trailing whitespace from source
[platform/upstream/c-ares.git] / ares.h
1 /* $Id$ */
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
23 #if defined(_AIX) || defined(NETWARE)
24 /* HP-UX systems version 9, 10 and 11 lack sys/select.h and so does oldish
25    libc5-based Linux systems. Only include it on system that are known to
26    require it! */
27 #include <sys/select.h>
28 #endif
29
30 #if defined(WATT32)
31   #include <netinet/in.h>
32   #include <tcp.h>
33 #elif defined(WIN32)
34   #include <winsock.h>
35   #include <windows.h>
36 #else
37   #include <netinet/in.h>
38 #endif
39
40 #define ARES_SUCCESS            0
41
42 /* Server error codes (ARES_ENODATA indicates no relevant answer) */
43 #define ARES_ENODATA            1
44 #define ARES_EFORMERR           2
45 #define ARES_ESERVFAIL          3
46 #define ARES_ENOTFOUND          4
47 #define ARES_ENOTIMP            5
48 #define ARES_EREFUSED           6
49
50 /* Locally generated error codes */
51 #define ARES_EBADQUERY          7
52 #define ARES_EBADNAME           8
53 #define ARES_EBADFAMILY         9
54 #define ARES_EBADRESP           10
55 #define ARES_ECONNREFUSED       11
56 #define ARES_ETIMEOUT           12
57 #define ARES_EOF                13
58 #define ARES_EFILE              14
59 #define ARES_ENOMEM             15
60 #define ARES_EDESTRUCTION       16
61 #define ARES_EBADSTR            17
62
63 /* Flag values */
64 #define ARES_FLAG_USEVC         (1 << 0)
65 #define ARES_FLAG_PRIMARY       (1 << 1)
66 #define ARES_FLAG_IGNTC         (1 << 2)
67 #define ARES_FLAG_NORECURSE     (1 << 3)
68 #define ARES_FLAG_STAYOPEN      (1 << 4)
69 #define ARES_FLAG_NOSEARCH      (1 << 5)
70 #define ARES_FLAG_NOALIASES     (1 << 6)
71 #define ARES_FLAG_NOCHECKRESP   (1 << 7)
72
73 /* Option mask values */
74 #define ARES_OPT_FLAGS          (1 << 0)
75 #define ARES_OPT_TIMEOUT        (1 << 1)
76 #define ARES_OPT_TRIES          (1 << 2)
77 #define ARES_OPT_NDOTS          (1 << 3)
78 #define ARES_OPT_UDP_PORT       (1 << 4)
79 #define ARES_OPT_TCP_PORT       (1 << 5)
80 #define ARES_OPT_SERVERS        (1 << 6)
81 #define ARES_OPT_DOMAINS        (1 << 7)
82 #define ARES_OPT_LOOKUPS        (1 << 8)
83
84 struct ares_options {
85   int flags;
86   int timeout;
87   int tries;
88   int ndots;
89   unsigned short udp_port;
90   unsigned short tcp_port;
91   struct in_addr *servers;
92   int nservers;
93   char **domains;
94   int ndomains;
95   char *lookups;
96 };
97
98 struct hostent;
99 struct timeval;
100 struct ares_channeldata;
101 typedef struct ares_channeldata *ares_channel;
102 typedef void (*ares_callback)(void *arg, int status, unsigned char *abuf,
103                               int alen);
104 typedef void (*ares_host_callback)(void *arg, int status,
105                                    struct hostent *hostent);
106
107 int ares_init(ares_channel *channelptr);
108 int ares_init_options(ares_channel *channelptr, struct ares_options *options,
109                       int optmask);
110 void ares_destroy(ares_channel channel);
111 void ares_cancel(ares_channel channel);
112 void ares_send(ares_channel channel, const unsigned char *qbuf, int qlen,
113                ares_callback callback, void *arg);
114 void ares_query(ares_channel channel, const char *name, int dnsclass,
115                 int type, ares_callback callback, void *arg);
116 void ares_search(ares_channel channel, const char *name, int dnsclass,
117                  int type, ares_callback callback, void *arg);
118 void ares_gethostbyname(ares_channel channel, const char *name, int family,
119                         ares_host_callback callback, void *arg);
120 void ares_gethostbyaddr(ares_channel channel, const void *addr, int addrlen,
121                         int family, ares_host_callback callback, void *arg);
122
123 int ares_fds(ares_channel channel, fd_set *read_fds, fd_set *write_fds);
124 struct timeval *ares_timeout(ares_channel channel, struct timeval *maxtv,
125                              struct timeval *tv);
126 void ares_process(ares_channel channel, fd_set *read_fds, fd_set *write_fds);
127
128 int ares_mkquery(const char *name, int dnsclass, int type, unsigned short id,
129                  int rd, unsigned char **buf, int *buflen);
130 int ares_expand_name(const unsigned char *encoded, const unsigned char *abuf,
131                      int alen, char **s, long *enclen);
132 int ares_expand_string(const unsigned char *encoded, const unsigned char *abuf,
133                      int alen, unsigned char **s, long *enclen);
134 int ares_parse_a_reply(const unsigned char *abuf, int alen,
135                        struct hostent **host);
136 int ares_parse_ptr_reply(const unsigned char *abuf, int alen, const void *addr,
137                          int addrlen, int family, struct hostent **host);
138 void ares_free_string(void *str);
139 void ares_free_hostent(struct hostent *host);
140 const char *ares_strerror(int code);
141 void ares_free_errmem(char *mem);
142
143 #endif /* ARES__H */