123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332 |
- /* $Id$ */
- /* Copyright 1998 by the Massachusetts Institute of Technology.
- * Copyright (C) 2007-2009 by Daniel Stenberg
- *
- * Permission to use, copy, modify, and distribute this
- * software and its documentation for any purpose and without
- * fee is hereby granted, provided that the above copyright
- * notice appear in all copies and that both that copyright
- * notice and this permission notice appear in supporting
- * documentation, and that the name of M.I.T. not be used in
- * advertising or publicity pertaining to distribution of the
- * software without specific, written prior permission.
- * M.I.T. makes no representations about the suitability of
- * this software for any purpose. It is provided "as is"
- * without express or implied warranty.
- */
- #ifndef ARES__H
- #define ARES__H
- #include "ares_build.h" /* c-ares build definitions */
- #include "ares_rules.h" /* c-ares rules enforcement */
- /*
- * Define WIN32 when build target is Win32 API
- */
- #if (defined(_WIN32) || defined(__WIN32__)) && !defined(WIN32)
- #define WIN32
- #endif
- #include <sys/types.h>
- /* HP-UX systems version 9, 10 and 11 lack sys/select.h and so does oldish
- libc5-based Linux systems. Only include it on system that are known to
- require it! */
- #if defined(_AIX) || defined(__NOVELL_LIBC__) || defined(__NetBSD__) || \
- defined(__minix) || defined(__SYMBIAN32__) || defined(__INTEGRITY)
- #include <sys/select.h>
- #endif
- #if (defined(NETWARE) && !defined(__NOVELL_LIBC__))
- #include <sys/bsdskt.h>
- #endif
- #if defined(WATT32)
- #include <netinet/in.h>
- #include <sys/socket.h>
- #include <tcp.h>
- #elif defined(WIN32)
- # ifndef WIN32_LEAN_AND_MEAN
- # define WIN32_LEAN_AND_MEAN
- # endif
- # include <windows.h>
- # include <winsock2.h>
- # include <ws2tcpip.h>
- #else
- #include <sys/socket.h>
- #include <netinet/in.h>
- #endif
- #ifdef __cplusplus
- extern "C" {
- #endif
- #define ARES_SUCCESS 0
- /* Server error codes (ARES_ENODATA indicates no relevant answer) */
- #define ARES_ENODATA 1
- #define ARES_EFORMERR 2
- #define ARES_ESERVFAIL 3
- #define ARES_ENOTFOUND 4
- #define ARES_ENOTIMP 5
- #define ARES_EREFUSED 6
- /* Locally generated error codes */
- #define ARES_EBADQUERY 7
- #define ARES_EBADNAME 8
- #define ARES_EBADFAMILY 9
- #define ARES_EBADRESP 10
- #define ARES_ECONNREFUSED 11
- #define ARES_ETIMEOUT 12
- #define ARES_EOF 13
- #define ARES_EFILE 14
- #define ARES_ENOMEM 15
- #define ARES_EDESTRUCTION 16
- #define ARES_EBADSTR 17
- /* ares_getnameinfo error codes */
- #define ARES_EBADFLAGS 18
- /* ares_getaddrinfo error codes */
- #define ARES_ENONAME 19
- #define ARES_EBADHINTS 20
- /* Flag values */
- #define ARES_FLAG_USEVC (1 << 0)
- #define ARES_FLAG_PRIMARY (1 << 1)
- #define ARES_FLAG_IGNTC (1 << 2)
- #define ARES_FLAG_NORECURSE (1 << 3)
- #define ARES_FLAG_STAYOPEN (1 << 4)
- #define ARES_FLAG_NOSEARCH (1 << 5)
- #define ARES_FLAG_NOALIASES (1 << 6)
- #define ARES_FLAG_NOCHECKRESP (1 << 7)
- /* Option mask values */
- #define ARES_OPT_FLAGS (1 << 0)
- #define ARES_OPT_TIMEOUT (1 << 1)
- #define ARES_OPT_TRIES (1 << 2)
- #define ARES_OPT_NDOTS (1 << 3)
- #define ARES_OPT_UDP_PORT (1 << 4)
- #define ARES_OPT_TCP_PORT (1 << 5)
- #define ARES_OPT_SERVERS (1 << 6)
- #define ARES_OPT_DOMAINS (1 << 7)
- #define ARES_OPT_LOOKUPS (1 << 8)
- #define ARES_OPT_SOCK_STATE_CB (1 << 9)
- #define ARES_OPT_SORTLIST (1 << 10)
- #define ARES_OPT_SOCK_SNDBUF (1 << 11)
- #define ARES_OPT_SOCK_RCVBUF (1 << 12)
- #define ARES_OPT_TIMEOUTMS (1 << 13)
- #define ARES_OPT_ROTATE (1 << 14)
- /* Nameinfo flag values */
- #define ARES_NI_NOFQDN (1 << 0)
- #define ARES_NI_NUMERICHOST (1 << 1)
- #define ARES_NI_NAMEREQD (1 << 2)
- #define ARES_NI_NUMERICSERV (1 << 3)
- #define ARES_NI_DGRAM (1 << 4)
- #define ARES_NI_TCP 0
- #define ARES_NI_UDP ARES_NI_DGRAM
- #define ARES_NI_SCTP (1 << 5)
- #define ARES_NI_DCCP (1 << 6)
- #define ARES_NI_NUMERICSCOPE (1 << 7)
- #define ARES_NI_LOOKUPHOST (1 << 8)
- #define ARES_NI_LOOKUPSERVICE (1 << 9)
- /* Reserved for future use */
- #define ARES_NI_IDN (1 << 10)
- #define ARES_NI_IDN_ALLOW_UNASSIGNED (1 << 11)
- #define ARES_NI_IDN_USE_STD3_ASCII_RULES (1 << 12)
- /* Addrinfo flag values */
- #define ARES_AI_CANONNAME (1 << 0)
- #define ARES_AI_NUMERICHOST (1 << 1)
- #define ARES_AI_PASSIVE (1 << 2)
- #define ARES_AI_NUMERICSERV (1 << 3)
- #define ARES_AI_V4MAPPED (1 << 4)
- #define ARES_AI_ALL (1 << 5)
- #define ARES_AI_ADDRCONFIG (1 << 6)
- /* Reserved for future use */
- #define ARES_AI_IDN (1 << 10)
- #define ARES_AI_IDN_ALLOW_UNASSIGNED (1 << 11)
- #define ARES_AI_IDN_USE_STD3_ASCII_RULES (1 << 12)
- #define ARES_AI_CANONIDN (1 << 13)
- #define ARES_AI_MASK (ARES_AI_CANONNAME|ARES_AI_NUMERICHOST|ARES_AI_PASSIVE| \
- ARES_AI_NUMERICSERV|ARES_AI_V4MAPPED|ARES_AI_ALL| \
- ARES_AI_ADDRCONFIG)
- #define ARES_GETSOCK_MAXNUM 16 /* ares_getsock() can return info about this
- many sockets */
- #define ARES_GETSOCK_READABLE(bits,num) (bits & (1<< (num)))
- #define ARES_GETSOCK_WRITABLE(bits,num) (bits & (1 << ((num) + \
- ARES_GETSOCK_MAXNUM)))
- /*
- * Typedef our socket type
- */
- #ifndef ares_socket_typedef
- #ifdef WIN32
- typedef SOCKET ares_socket_t;
- #define ARES_SOCKET_BAD INVALID_SOCKET
- #else
- typedef int ares_socket_t;
- #define ARES_SOCKET_BAD -1
- #endif
- #define ares_socket_typedef
- #endif /* ares_socket_typedef */
- typedef void (*ares_sock_state_cb)(void *data,
- ares_socket_t socket_fd,
- int readable,
- int writable);
- struct apattern;
- /* NOTE about the ares_options struct to users and developers.
- This struct will remain looking like this. It will not be extended nor
- shrunk in future releases, but all new options will be set by ares_set_*()
- options instead of with the ares_init_options() function.
- Eventually (in a galaxy far far away), all options will be settable by
- ares_set_*() options and the ares_init_options() function will become
- deprecated.
- When new options are added to c-ares, they are not added to this
- struct. And they are not "saved" with the ares_save_options() function but
- instead we encourage the use of the ares_dup() function. Needless to say,
- if you add config options to c-ares you need to make sure ares_dup()
- duplicates this new option.
- */
- struct ares_options {
- int flags;
- int timeout; /* in seconds or milliseconds, depending on options */
- int tries;
- int ndots;
- unsigned short udp_port;
- unsigned short tcp_port;
- int socket_send_buffer_size;
- int socket_receive_buffer_size;
- struct in_addr *servers;
- int nservers;
- char **domains;
- int ndomains;
- char *lookups;
- ares_sock_state_cb sock_state_cb;
- void *sock_state_cb_data;
- struct apattern *sortlist;
- int nsort;
- };
- struct hostent;
- struct timeval;
- struct sockaddr;
- struct ares_channeldata;
- typedef struct ares_channeldata *ares_channel;
- typedef void (*ares_callback)(void *arg, int status, int timeouts,
- unsigned char *abuf, int alen);
- typedef void (*ares_host_callback)(void *arg, int status, int timeouts,
- struct hostent *hostent);
- typedef void (*ares_nameinfo_callback)(void *arg, int status, int timeouts,
- char *node, char *service);
- typedef int (*ares_sock_create_callback)(ares_socket_t socket_fd,
- int type, void *data);
- int ares_init(ares_channel *channelptr);
- int ares_init_options(ares_channel *channelptr, struct ares_options *options,
- int optmask);
- int ares_save_options(ares_channel channel, struct ares_options *options,
- int *optmask);
- void ares_destroy_options(struct ares_options *options);
- int ares_dup(ares_channel *dest, ares_channel src);
- void ares_destroy(ares_channel channel);
- void ares_cancel(ares_channel channel);
- void ares_set_socket_callback(ares_channel channel,
- ares_sock_create_callback callback,
- void *user_data);
- void ares_send(ares_channel channel, const unsigned char *qbuf, int qlen,
- ares_callback callback, void *arg);
- void ares_query(ares_channel channel, const char *name, int dnsclass,
- int type, ares_callback callback, void *arg);
- void ares_search(ares_channel channel, const char *name, int dnsclass,
- int type, ares_callback callback, void *arg);
- void ares_gethostbyname(ares_channel channel, const char *name, int family,
- ares_host_callback callback, void *arg);
- int ares_gethostbyname_file(ares_channel channel, const char *name,
- int family, struct hostent **host);
- void ares_gethostbyaddr(ares_channel channel, const void *addr, int addrlen,
- int family, ares_host_callback callback, void *arg);
- void ares_getnameinfo(ares_channel channel, const struct sockaddr *sa,
- ares_socklen_t salen, int flags,
- ares_nameinfo_callback callback,
- void *arg);
- int ares_fds(ares_channel channel, fd_set *read_fds, fd_set *write_fds);
- int ares_getsock(ares_channel channel, int *socks, int numsocks);
- struct timeval *ares_timeout(ares_channel channel, struct timeval *maxtv,
- struct timeval *tv);
- void ares_process(ares_channel channel, fd_set *read_fds, fd_set *write_fds);
- void ares_process_fd(ares_channel channel, ares_socket_t read_fd,
- ares_socket_t write_fd);
- int ares_mkquery(const char *name, int dnsclass, int type, unsigned short id,
- int rd, unsigned char **buf, int *buflen);
- int ares_expand_name(const unsigned char *encoded, const unsigned char *abuf,
- int alen, char **s, long *enclen);
- int ares_expand_string(const unsigned char *encoded, const unsigned char *abuf,
- int alen, unsigned char **s, long *enclen);
- /*
- * NOTE: before c-ares 1.6.1 we would most often use the system in6_addr
- * struct below when ares itself was built, but many apps would use this
- * private version since the header checked a HAVE_* define for it. Starting
- * with 1.6.1 we always declare and use our own to stop relying on the
- * system's one.
- */
- struct ares_in6_addr {
- union {
- unsigned char _S6_u8[16];
- } _S6_un;
- };
- /*
- * TODO: the structs 'addrttl' and 'addr6ttl' really should get their names
- * prefixed with ares_ to keep them in our own "name space".
- */
- struct addrttl {
- struct in_addr ipaddr;
- int ttl;
- };
- struct addr6ttl {
- struct ares_in6_addr ip6addr;
- int ttl;
- };
- /*
- ** Parse the buffer, starting at *abuf and of length alen bytes, previously
- ** obtained from an ares_search call. Put the results in *host, if nonnull.
- ** Also, if addrttls is nonnull, put up to *naddrttls IPv4 addresses along with
- ** their TTLs in that array, and set *naddrttls to the number of addresses
- ** so written.
- */
- int ares_parse_a_reply(const unsigned char *abuf, int alen,
- struct hostent **host,
- struct addrttl *addrttls, int *naddrttls);
- int ares_parse_aaaa_reply(const unsigned char *abuf, int alen,
- struct hostent **host,
- struct addr6ttl *addrttls, int *naddrttls);
- int ares_parse_ptr_reply(const unsigned char *abuf, int alen, const void *addr,
- int addrlen, int family, struct hostent **host);
- int ares_parse_ns_reply(const unsigned char *abuf, int alen,
- struct hostent **host);
- void ares_free_string(void *str);
- void ares_free_hostent(struct hostent *host);
- const char *ares_strerror(int code);
- #ifdef __cplusplus
- }
- #endif
- #endif /* ARES__H */
|