dnscrypto-proxy: Update to release 1.3.0
[tomato.git] / release / src / router / dnscrypt / src / libevent-modified / include / event2 / dns.h
bloba4de05b6f8876e2e50a21e966e4c50bc5079dfb7
1 /*
2 * Copyright (c) 2006-2007 Niels Provos <provos@citi.umich.edu>
3 * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. The name of the author may not be used to endorse or promote products
14 * derived from this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 * The original DNS code is due to Adam Langley with heavy
30 * modifications by Nick Mathewson. Adam put his DNS software in the
31 * public domain. You can find his original copyright below. Please,
32 * aware that the code as part of Libevent is governed by the 3-clause
33 * BSD license above.
35 * This software is Public Domain. To view a copy of the public domain dedication,
36 * visit http://creativecommons.org/licenses/publicdomain/ or send a letter to
37 * Creative Commons, 559 Nathan Abbott Way, Stanford, California 94305, USA.
39 * I ask and expect, but do not require, that all derivative works contain an
40 * attribution similar to:
41 * Parts developed by Adam Langley <agl@imperialviolet.org>
43 * You may wish to replace the word "Parts" with something else depending on
44 * the amount of original code.
46 * (Derivative works does not include programs which link against, run or include
47 * the source verbatim in their source distributions)
50 /** @file event2/dns.h
52 * Welcome, gentle reader
54 * Async DNS lookups are really a whole lot harder than they should be,
55 * mostly stemming from the fact that the libc resolver has never been
56 * very good at them. Before you use this library you should see if libc
57 * can do the job for you with the modern async call getaddrinfo_a
58 * (see http://www.imperialviolet.org/page25.html#e498). Otherwise,
59 * please continue.
61 * The library keeps track of the state of nameservers and will avoid
62 * them when they go down. Otherwise it will round robin between them.
64 * Quick start guide:
65 * #include "evdns.h"
66 * void callback(int result, char type, int count, int ttl,
67 * void *addresses, void *arg);
68 * evdns_resolv_conf_parse(DNS_OPTIONS_ALL, "/etc/resolv.conf");
69 * evdns_resolve("www.hostname.com", 0, callback, NULL);
71 * When the lookup is complete the callback function is called. The
72 * first argument will be one of the DNS_ERR_* defines in evdns.h.
73 * Hopefully it will be DNS_ERR_NONE, in which case type will be
74 * DNS_IPv4_A, count will be the number of IP addresses, ttl is the time
75 * which the data can be cached for (in seconds), addresses will point
76 * to an array of uint32_t's and arg will be whatever you passed to
77 * evdns_resolve.
79 * Searching:
81 * In order for this library to be a good replacement for glibc's resolver it
82 * supports searching. This involves setting a list of default domains, in
83 * which names will be queried for. The number of dots in the query name
84 * determines the order in which this list is used.
86 * Searching appears to be a single lookup from the point of view of the API,
87 * although many DNS queries may be generated from a single call to
88 * evdns_resolve. Searching can also drastically slow down the resolution
89 * of names.
91 * To disable searching:
92 * 1. Never set it up. If you never call evdns_resolv_conf_parse or
93 * evdns_search_add then no searching will occur.
95 * 2. If you do call evdns_resolv_conf_parse then don't pass
96 * DNS_OPTION_SEARCH (or DNS_OPTIONS_ALL, which implies it).
98 * 3. When calling evdns_resolve, pass the DNS_QUERY_NO_SEARCH flag.
100 * The order of searches depends on the number of dots in the name. If the
101 * number is greater than the ndots setting then the names is first tried
102 * globally. Otherwise each search domain is appended in turn.
104 * The ndots setting can either be set from a resolv.conf, or by calling
105 * evdns_search_ndots_set.
107 * For example, with ndots set to 1 (the default) and a search domain list of
108 * ["myhome.net"]:
109 * Query: www
110 * Order: www.myhome.net, www.
112 * Query: www.abc
113 * Order: www.abc., www.abc.myhome.net
115 * Internals:
117 * Requests are kept in two queues. The first is the inflight queue. In
118 * this queue requests have an allocated transaction id and nameserver.
119 * They will soon be transmitted if they haven't already been.
121 * The second is the waiting queue. The size of the inflight ring is
122 * limited and all other requests wait in waiting queue for space. This
123 * bounds the number of concurrent requests so that we don't flood the
124 * nameserver. Several algorithms require a full walk of the inflight
125 * queue and so bounding its size keeps thing going nicely under huge
126 * (many thousands of requests) loads.
128 * If a nameserver loses too many requests it is considered down and we
129 * try not to use it. After a while we send a probe to that nameserver
130 * (a lookup for google.com) and, if it replies, we consider it working
131 * again. If the nameserver fails a probe we wait longer to try again
132 * with the next probe.
135 #ifndef _EVENT2_DNS_H_
136 #define _EVENT2_DNS_H_
138 #ifdef __cplusplus
139 extern "C" {
140 #endif
142 /* For integer types. */
143 #include <event2/util.h>
145 /** Error codes 0-5 are as described in RFC 1035. */
146 #define DNS_ERR_NONE 0
147 /** The name server was unable to interpret the query */
148 #define DNS_ERR_FORMAT 1
149 /** The name server was unable to process this query due to a problem with the
150 * name server */
151 #define DNS_ERR_SERVERFAILED 2
152 /** The domain name does not exist */
153 #define DNS_ERR_NOTEXIST 3
154 /** The name server does not support the requested kind of query */
155 #define DNS_ERR_NOTIMPL 4
156 /** The name server refuses to reform the specified operation for policy
157 * reasons */
158 #define DNS_ERR_REFUSED 5
159 /** The reply was truncated or ill-formatted */
160 #define DNS_ERR_TRUNCATED 65
161 /** An unknown error occurred */
162 #define DNS_ERR_UNKNOWN 66
163 /** Communication with the server timed out */
164 #define DNS_ERR_TIMEOUT 67
165 /** The request was canceled because the DNS subsystem was shut down. */
166 #define DNS_ERR_SHUTDOWN 68
167 /** The request was canceled via a call to evdns_cancel_request */
168 #define DNS_ERR_CANCEL 69
169 /** There were no answers and no error condition in the DNS packet.
170 * This can happen when you ask for an address that exists, but a record
171 * type that doesn't. */
172 #define DNS_ERR_NODATA 70
174 #define DNS_IPv4_A 1
175 #define DNS_PTR 2
176 #define DNS_IPv6_AAAA 3
177 #define DNS_TXT 4
179 #define DNS_QUERY_NO_SEARCH 1
181 #define DNS_OPTION_SEARCH 1
182 #define DNS_OPTION_NAMESERVERS 2
183 #define DNS_OPTION_MISC 4
184 #define DNS_OPTION_HOSTSFILE 8
185 #define DNS_OPTIONS_ALL 15
187 /* Obsolete name for DNS_QUERY_NO_SEARCH */
188 #define DNS_NO_SEARCH DNS_QUERY_NO_SEARCH
190 struct txt_record {
191 char txt[255];
192 size_t len;
196 * The callback that contains the results from a lookup.
197 * - result is one of the DNS_ERR_* values (DNS_ERR_NONE for success)
198 * - type is either DNS_IPv4_A or DNS_PTR or DNS_IPv6_AAAA or DNS_TXT
199 * - count contains the number of addresses of form type
200 * - ttl is the number of seconds the resolution may be cached for.
201 * - addresses needs to be cast according to type. It will be an array of
202 * 4-byte sequences for ipv4, or an array of 16-byte sequences for ipv6,
203 * or a nul-terminated string for PTR.
205 typedef void (*evdns_callback_type) (int result, char type, int count, int ttl, void *addresses, void *arg);
207 struct evdns_base;
208 struct event_base;
211 Initialize the asynchronous DNS library.
213 This function initializes support for non-blocking name resolution by
214 calling evdns_resolv_conf_parse() on UNIX and
215 evdns_config_windows_nameservers() on Windows.
217 @param event_base the event base to associate the dns client with
218 @param initialize_nameservers 1 if resolve.conf processing should occur
219 @return evdns_base object if successful, or NULL if an error occurred.
220 @see evdns_base_free()
222 struct evdns_base * evdns_base_new(struct event_base *event_base, int initialize_nameservers);
226 Shut down the asynchronous DNS resolver and terminate all active requests.
228 If the 'fail_requests' option is enabled, all active requests will return
229 an empty result with the error flag set to DNS_ERR_SHUTDOWN. Otherwise,
230 the requests will be silently discarded.
232 @param evdns_base the evdns base to free
233 @param fail_requests if zero, active requests will be aborted; if non-zero,
234 active requests will return DNS_ERR_SHUTDOWN.
235 @see evdns_base_new()
237 void evdns_base_free(struct evdns_base *base, int fail_requests);
240 Convert a DNS error code to a string.
242 @param err the DNS error code
243 @return a string containing an explanation of the error code
245 const char *evdns_err_to_string(int err);
249 Add a nameserver.
251 The address should be an IPv4 address in network byte order.
252 The type of address is chosen so that it matches in_addr.s_addr.
254 @param base the evdns_base to which to add the name server
255 @param address an IP address in network byte order
256 @return 0 if successful, or -1 if an error occurred
257 @see evdns_base_nameserver_ip_add()
259 int evdns_base_nameserver_add(struct evdns_base *base,
260 unsigned long int address);
263 Get the number of configured nameservers.
265 This returns the number of configured nameservers (not necessarily the
266 number of running nameservers). This is useful for double-checking
267 whether our calls to the various nameserver configuration functions
268 have been successful.
270 @param base the evdns_base to which to apply this operation
271 @return the number of configured nameservers
272 @see evdns_base_nameserver_add()
274 int evdns_base_count_nameservers(struct evdns_base *base);
277 Remove all configured nameservers, and suspend all pending resolves.
279 Resolves will not necessarily be re-attempted until evdns_base_resume() is called.
281 @param base the evdns_base to which to apply this operation
282 @return 0 if successful, or -1 if an error occurred
283 @see evdns_base_resume()
285 int evdns_base_clear_nameservers_and_suspend(struct evdns_base *base);
289 Resume normal operation and continue any suspended resolve requests.
291 Re-attempt resolves left in limbo after an earlier call to
292 evdns_base_clear_nameservers_and_suspend().
294 @param base the evdns_base to which to apply this operation
295 @return 0 if successful, or -1 if an error occurred
296 @see evdns_base_clear_nameservers_and_suspend()
298 int evdns_base_resume(struct evdns_base *base);
301 Add a nameserver by string address.
303 This function parses a n IPv4 or IPv6 address from a string and adds it as a
304 nameserver. It supports the following formats:
305 - [IPv6Address]:port
306 - [IPv6Address]
307 - IPv6Address
308 - IPv4Address:port
309 - IPv4Address
311 If no port is specified, it defaults to 53.
313 @param base the evdns_base to which to apply this operation
314 @return 0 if successful, or -1 if an error occurred
315 @see evdns_base_nameserver_add()
317 int evdns_base_nameserver_ip_add(struct evdns_base *base,
318 const char *ip_as_string);
321 Add a nameserver by sockaddr.
324 evdns_base_nameserver_sockaddr_add(struct evdns_base *base,
325 const struct sockaddr *sa, ev_socklen_t len, unsigned flags);
327 struct evdns_request;
330 Lookup an A record for a given name.
332 @param base the evdns_base to which to apply this operation
333 @param name a DNS hostname
334 @param flags either 0, or DNS_QUERY_NO_SEARCH to disable searching for this query.
335 @param callback a callback function to invoke when the request is completed
336 @param ptr an argument to pass to the callback function
337 @return an evdns_request object if successful, or NULL if an error occurred.
338 @see evdns_resolve_ipv6(), evdns_resolve_reverse(), evdns_resolve_reverse_ipv6(), evdns_cancel_request()
340 struct evdns_request *evdns_base_resolve_ipv4(struct evdns_base *base, const char *name, int flags, evdns_callback_type callback, void *ptr);
343 Lookup an AAAA record for a given name.
345 @param base the evdns_base to which to apply this operation
346 @param name a DNS hostname
347 @param flags either 0, or DNS_QUERY_NO_SEARCH to disable searching for this query.
348 @param callback a callback function to invoke when the request is completed
349 @param ptr an argument to pass to the callback function
350 @return an evdns_request object if successful, or NULL if an error occurred.
351 @see evdns_resolve_ipv4(), evdns_resolve_reverse(), evdns_resolve_reverse_ipv6(), evdns_cancel_request()
353 struct evdns_request *evdns_base_resolve_ipv6(struct evdns_base *base, const char *name, int flags, evdns_callback_type callback, void *ptr);
355 struct in_addr;
356 struct in6_addr;
359 Lookup a PTR record for a given IP address.
361 @param base the evdns_base to which to apply this operation
362 @param in an IPv4 address
363 @param flags either 0, or DNS_QUERY_NO_SEARCH to disable searching for this query.
364 @param callback a callback function to invoke when the request is completed
365 @param ptr an argument to pass to the callback function
366 @return an evdns_request object if successful, or NULL if an error occurred.
367 @see evdns_resolve_reverse_ipv6(), evdns_cancel_request()
369 struct evdns_request *evdns_base_resolve_reverse(struct evdns_base *base, const struct in_addr *in, int flags, evdns_callback_type callback, void *ptr);
373 Lookup a PTR record for a given IPv6 address.
375 @param base the evdns_base to which to apply this operation
376 @param in an IPv6 address
377 @param flags either 0, or DNS_QUERY_NO_SEARCH to disable searching for this query.
378 @param callback a callback function to invoke when the request is completed
379 @param ptr an argument to pass to the callback function
380 @return an evdns_request object if successful, or NULL if an error occurred.
381 @see evdns_resolve_reverse_ipv6(), evdns_cancel_request()
383 struct evdns_request *evdns_base_resolve_reverse_ipv6(struct evdns_base *base, const struct in6_addr *in, int flags, evdns_callback_type callback, void *ptr);
386 Lookup a TXT record for a given name.
388 @param base the evdns_base to which to apply this operation
389 @param name a DNS hostname
390 @param flags either 0, or DNS_QUERY_NO_SEARCH to disable searching for this query.
391 @param callback a callback function to invoke when the request is completed
392 @param ptr an argument to pass to the callback function
393 @return an evdns_request object if successful, or NULL if an error occurred.
395 struct evdns_request *evdns_base_resolve_txt(struct evdns_base *base, const char *name, int flags, evdns_callback_type callback, void *ptr);
398 Cancels a pending DNS resolution request.
400 @param base the evdns_base that was used to make the request
401 @param req the evdns_request that was returned by calling a resolve function
402 @see evdns_base_resolve_ipv4(), evdns_base_resolve_ipv6, evdns_base_resolve_reverse
404 void evdns_cancel_request(struct evdns_base *base, struct evdns_request *req);
407 Set the value of a configuration option.
409 The currently available configuration options are:
411 ndots, timeout, max-timeouts, max-inflight, attempts, randomize-case,
412 bind-to, initial-probe-timeout, getaddrinfo-allow-skew.
414 In versions before Libevent 2.0.3-alpha, the option name needed to end with
415 a colon.
417 @param base the evdns_base to which to apply this operation
418 @param option the name of the configuration option to be modified
419 @param val the value to be set
420 @return 0 if successful, or -1 if an error occurred
422 int evdns_base_set_option(struct evdns_base *base, const char *option, const char *val);
426 Parse a resolv.conf file.
428 The 'flags' parameter determines what information is parsed from the
429 resolv.conf file. See the man page for resolv.conf for the format of this
430 file.
432 The following directives are not parsed from the file: sortlist, rotate,
433 no-check-names, inet6, debug.
435 If this function encounters an error, the possible return values are: 1 =
436 failed to open file, 2 = failed to stat file, 3 = file too large, 4 = out of
437 memory, 5 = short read from file, 6 = no nameservers listed in the file
439 @param base the evdns_base to which to apply this operation
440 @param flags any of DNS_OPTION_NAMESERVERS|DNS_OPTION_SEARCH|DNS_OPTION_MISC|
441 DNS_OPTIONS_HOSTSFILE|DNS_OPTIONS_ALL
442 @param filename the path to the resolv.conf file
443 @return 0 if successful, or various positive error codes if an error
444 occurred (see above)
445 @see resolv.conf(3), evdns_config_windows_nameservers()
447 int evdns_base_resolv_conf_parse(struct evdns_base *base, int flags, const char *const filename);
450 Load an /etc/hosts-style file from 'hosts_fname' into 'base'.
452 If hosts_fname is NULL, add minimal entries for localhost, and nothing
453 else.
455 Note that only evdns_getaddrinfo uses the /etc/hosts entries.
457 Return 0 on success, negative on failure.
459 int evdns_base_load_hosts(struct evdns_base *base, const char *hosts_fname);
462 Obtain nameserver information using the Windows API.
464 Attempt to configure a set of nameservers based on platform settings on
465 a win32 host. Preferentially tries to use GetNetworkParams; if that fails,
466 looks in the registry.
468 @return 0 if successful, or -1 if an error occurred
469 @see evdns_resolv_conf_parse()
471 #ifdef WIN32
472 int evdns_base_config_windows_nameservers(struct evdns_base *);
473 #define EVDNS_BASE_CONFIG_WINDOWS_NAMESERVERS_IMPLEMENTED
474 #endif
478 Clear the list of search domains.
480 void evdns_base_search_clear(struct evdns_base *base);
484 Add a domain to the list of search domains
486 @param domain the domain to be added to the search list
488 void evdns_base_search_add(struct evdns_base *base, const char *domain);
492 Set the 'ndots' parameter for searches.
494 Sets the number of dots which, when found in a name, causes
495 the first query to be without any search domain.
497 @param ndots the new ndots parameter
499 void evdns_base_search_ndots_set(struct evdns_base *base, const int ndots);
502 A callback that is invoked when a log message is generated
504 @param is_warning indicates if the log message is a 'warning'
505 @param msg the content of the log message
507 typedef void (*evdns_debug_log_fn_type)(int is_warning, const char *msg);
511 Set the callback function to handle DNS log messages. If this
512 callback is not set, evdns log messages are handled with the regular
513 Libevent logging system.
515 @param fn the callback to be invoked when a log message is generated
517 void evdns_set_log_fn(evdns_debug_log_fn_type fn);
520 Set a callback that will be invoked to generate transaction IDs. By
521 default, we pick transaction IDs based on the current clock time, which
522 is bad for security.
524 @param fn the new callback, or NULL to use the default.
526 NOTE: This function has no effect in Libevent 2.0.4-alpha and later,
527 since Libevent now uses evutil_secure_rng_init or the secure random bytes
528 generator set with evdns_set_random_bytes_fn().
530 void evdns_set_transaction_id_fn(ev_uint16_t (*fn)(void));
533 Set a function to initialize the pseudo-random generator.
534 The default function is evutil_secure_rng_init.
535 It can be NULL is no init function is required.
537 void evdns_set_random_init_fn(int (*fn)(void));
540 Set a callback used to generate random bytes. By default, we use
541 the same function as passed to evdns_set_transaction_id_fn to generate
542 bytes two at a time. If a function is provided here, it's also used
543 to generate transaction IDs.
545 void evdns_set_random_bytes_fn(void (*fn)(void *, size_t));
548 * Functions used to implement a DNS server.
551 struct evdns_server_request;
552 struct evdns_server_question;
555 A callback to implement a DNS server. The callback function receives a DNS
556 request. It should then optionally add a number of answers to the reply
557 using the evdns_server_request_add_*_reply functions, before calling either
558 evdns_server_request_respond to send the reply back, or
559 evdns_server_request_drop to decline to answer the request.
561 @param req A newly received request
562 @param user_data A pointer that was passed to
563 evdns_add_server_port_with_base().
565 typedef void (*evdns_request_callback_fn_type)(struct evdns_server_request *, void *);
566 #define EVDNS_ANSWER_SECTION 0
567 #define EVDNS_AUTHORITY_SECTION 1
568 #define EVDNS_ADDITIONAL_SECTION 2
570 #define EVDNS_TYPE_A 1
571 #define EVDNS_TYPE_NS 2
572 #define EVDNS_TYPE_CNAME 5
573 #define EVDNS_TYPE_SOA 6
574 #define EVDNS_TYPE_PTR 12
575 #define EVDNS_TYPE_MX 15
576 #define EVDNS_TYPE_TXT 16
577 #define EVDNS_TYPE_AAAA 28
579 #define EVDNS_QTYPE_AXFR 252
580 #define EVDNS_QTYPE_ALL 255
582 #define EVDNS_CLASS_INET 1
584 /* flags that can be set in answers; as part of the err parameter */
585 #define EVDNS_FLAGS_AA 0x400
586 #define EVDNS_FLAGS_RD 0x080
588 /** Create a new DNS server port.
590 @param base The event base to handle events for the server port.
591 @param socket A UDP socket to accept DNS requests.
592 @param flags Always 0 for now.
593 @param callback A function to invoke whenever we get a DNS request
594 on the socket.
595 @param user_data Data to pass to the callback.
596 @return an evdns_server_port structure for this server port.
598 struct evdns_server_port *evdns_add_server_port_with_base(struct event_base *base, evutil_socket_t socket, int flags, evdns_request_callback_fn_type callback, void *user_data);
599 /** Close down a DNS server port, and free associated structures. */
600 void evdns_close_server_port(struct evdns_server_port *port);
602 /** Sets some flags in a reply we're building.
603 Allows setting of the AA or RD flags
605 void evdns_server_request_set_flags(struct evdns_server_request *req, int flags);
607 /* Functions to add an answer to an in-progress DNS reply.
609 int evdns_server_request_add_reply(struct evdns_server_request *req, int section, const char *name, int type, int dns_class, int ttl, int datalen, int is_name, const char *data);
610 int evdns_server_request_add_a_reply(struct evdns_server_request *req, const char *name, int n, const void *addrs, int ttl);
611 int evdns_server_request_add_aaaa_reply(struct evdns_server_request *req, const char *name, int n, const void *addrs, int ttl);
612 int evdns_server_request_add_ptr_reply(struct evdns_server_request *req, struct in_addr *in, const char *inaddr_name, const char *hostname, int ttl);
613 int evdns_server_request_add_cname_reply(struct evdns_server_request *req, const char *name, const char *cname, int ttl);
616 Send back a response to a DNS request, and free the request structure.
618 int evdns_server_request_respond(struct evdns_server_request *req, int err);
620 Free a DNS request without sending back a reply.
622 int evdns_server_request_drop(struct evdns_server_request *req);
623 struct sockaddr;
625 Get the address that made a DNS request.
627 int evdns_server_request_get_requesting_addr(struct evdns_server_request *_req, struct sockaddr *sa, int addr_len);
629 /** Callback for evdns_getaddrinfo. */
630 typedef void (*evdns_getaddrinfo_cb)(int result, struct evutil_addrinfo *res, void *arg);
632 struct evdns_base;
633 struct evdns_getaddrinfo_request;
634 /** Make a non-blocking getaddrinfo request using the dns_base in 'dns_base'.
636 * If we can answer the request immediately (with an error or not!), then we
637 * invoke cb immediately and return NULL. Otherwise we return
638 * an evdns_getaddrinfo_request and invoke cb later.
640 * When the callback is invoked, we pass as its first argument the error code
641 * that getaddrinfo would return (or 0 for no error). As its second argument,
642 * we pass the evutil_addrinfo structures we found (or NULL on error). We
643 * pass 'arg' as the third argument.
645 * Limitations:
647 * - The AI_V4MAPPED and AI_ALL flags are not currently implemented.
648 * - For ai_socktype, we only handle SOCKTYPE_STREAM, SOCKTYPE_UDP, and 0.
649 * - For ai_protocol, we only handle IPPROTO_TCP, IPPROTO_UDP, and 0.
651 struct evdns_getaddrinfo_request *evdns_getaddrinfo(
652 struct evdns_base *dns_base,
653 const char *nodename, const char *servname,
654 const struct evutil_addrinfo *hints_in,
655 evdns_getaddrinfo_cb cb, void *arg);
657 /* Cancel an in-progress evdns_getaddrinfo. This MUST NOT be called after the
658 * getaddrinfo's callback has been invoked. The resolves will be canceled,
659 * and the callback will be invoked with the error EVUTIL_EAI_CANCEL. */
660 void evdns_getaddrinfo_cancel(struct evdns_getaddrinfo_request *req);
662 #ifdef __cplusplus
664 #endif
666 #endif /* !_EVENT2_DNS_H_ */