3 * - adns user-visible API (single-threaded, without any locking)
8 * Copyright (C) 1997-1999 Ian Jackson <ian@davenant.greenend.org.uk>
10 * It is part of adns, which is
11 * Copyright (C) 1997-2000 Ian Jackson <ian@davenant.greenend.org.uk>
12 * Copyright (C) 1999 Tony Finch <dot@dotat.at>
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2, or (at your option)
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
25 * For the benefit of certain LGPL'd `omnibus' software which provides
26 * a uniform interface to various things including adns, I make the
27 * following additional licence. I do this because the GPL would
28 * otherwise force either the omnibus software to be GPL'd or for the
29 * adns-using part to be distributed separately.
31 * So, you may also redistribute and/or modify adns.h (but only the
32 * public header file adns.h and not any other part of adns) under the
33 * terms of the GNU Library General Public License as published by the
34 * Free Software Foundation; either version 2 of the License, or (at
35 * your option) any later version.
37 * Note that adns itself is GPL'd. Authors of adns-using applications
38 * with GPL-incompatible licences, and people who distribute adns with
39 * applications where the whole distribution is not GPL'd, are still
40 * likely to be in violation of the GPL. Anyone who wants to do this
41 * should contact Ian Jackson. Please note that to avoid encouraging
42 * people to infringe the GPL as it applies the body of adns, Ian thinks
43 * that if you take advantage of the special exception to redistribute
44 * just adns.h under the LGPL, you should retain this paragraph in its
45 * place in the appropriate copyright statements.
48 * You should have received a copy of the GNU General Public License,
49 * or the GNU Library General Public License, as appropriate, along
50 * with this program; if not, write to the Free Software Foundation,
51 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
57 #ifndef ADNS_H_INCLUDED
58 #define ADNS_H_INCLUDED
62 #include <sys/socket.h>
63 #include <netinet/in.h>
64 #include <sys/types.h>
69 extern "C" { /* I really dislike this - iwj. */
72 /* All struct in_addr anywhere in adns are in NETWORK byte order. */
74 typedef struct adns__state *adns_state;
75 typedef struct adns__query *adns_query;
78 adns_if_noenv= 0x0001, /* do not look at environment */
79 adns_if_noerrprint= 0x0002, /* never print output to stderr (_debug overrides) */
80 adns_if_noserverwarn= 0x0004, /* do not warn to stderr about duff nameservers etc */
81 adns_if_debug= 0x0008, /* enable all output to stderr plus debug msgs */
82 adns_if_logpid= 0x0080, /* include pid in diagnostic output */
83 adns_if_noautosys= 0x0010, /* do not make syscalls at every opportunity */
84 adns_if_eintr= 0x0020, /* allow _wait and _synchronous to return EINTR */
85 adns_if_nosigpipe= 0x0040, /* applic has SIGPIPE set to SIG_IGN, do not protect */
86 adns_if_checkc_entex= 0x0100, /* do consistency checks on entry/exit to adns funcs */
87 adns_if_checkc_freq= 0x0300 /* do consistency checks very frequently (slow!) */
91 adns_qf_search= 0x00000001, /* use the searchlist */
92 adns_qf_usevc= 0x00000002, /* use a virtual circuit (TCP connection) */
93 adns_qf_owner= 0x00000004, /* fill in the owner field in the answer */
94 adns_qf_quoteok_query= 0x00000010, /* allow special chars in query domain */
95 adns_qf_quoteok_cname= 0x00000000, /* allow ... in CNAME we go via - now default */
96 adns_qf_quoteok_anshost= 0x00000040, /* allow ... in things supposed to be hostnames */
97 adns_qf_quotefail_cname= 0x00000080, /* refuse if quote-req chars in CNAME we go via */
98 adns_qf_cname_loose= 0x00000100, /* allow refs to CNAMEs - without, get _s_cname */
99 adns_qf_cname_forbid= 0x00000200, /* don't follow CNAMEs, instead give _s_cname */
100 adns__qf_internalmask= 0x0ff00000
104 adns__rrt_typemask= 0x0ffff,
105 adns__qtf_deref= 0x10000, /* dereference domains and perhaps produce extra data */
106 adns__qtf_mail822= 0x20000, /* make mailboxes be in RFC822 rcpt field format */
113 adns_r_ns= adns_r_ns_raw|adns__qtf_deref,
118 adns_r_soa= adns_r_soa_raw|adns__qtf_mail822,
121 adns_r_ptr= adns_r_ptr_raw|adns__qtf_deref,
126 adns_r_mx= adns_r_mx_raw|adns__qtf_deref,
131 adns_r_rp= adns_r_rp_raw|adns__qtf_mail822,
133 adns_r_addr= adns_r_a|adns__qtf_deref
138 * In queries without qf_quoteok_*, all domains must have standard
139 * legal syntax, or you get adns_s_querydomainvalid (if the query
140 * domain contains bad characters) or adns_s_answerdomaininvalid (if
141 * the answer contains bad characters).
143 * In queries _with_ qf_quoteok_*, domains in the query or response
144 * may contain any characters, quoted according to RFC1035 5.1. On
145 * input to adns, the char* is a pointer to the interior of a "
146 * delimited string, except that " may appear in it unquoted. On
147 * output, the char* is a pointer to a string which would be legal
148 * either inside or outside " delimiters; any character which isn't
149 * legal in a hostname (ie alphanumeric or hyphen) or one of _ / +
150 * (the three other punctuation characters commonly abused in domain
151 * names) will be quoted, as \X if it is a printing ASCII character or
154 * (The characters which will be unquoted are the printing 7-bit ASCII
155 * characters except the punctuation characters " ( ) @ ; $ \
157 * I.e. unquoted characters are alphanumerics, and the following
158 * punctuation characters: ! # % ^ & * - _ = + [ ] { }
160 * If the query goes via a CNAME then the canonical name (ie, the
161 * thing that the CNAME record refers to) is usually allowed to
162 * contain any characters, which will be quoted as above. With
163 * adns_qf_quotefail_cname you get adns_s_answerdomaininvalid when
164 * this happens. (This is a change from version 0.4 and earlier, in
165 * which failing the query was the default, and you had to say
166 * adns_qf_quoteok_cname to avoid this; that flag is now deprecated.)
168 * In version 0.4 and earlier, asking for _raw records containing
169 * mailboxes without specifying _qf_quoteok_anshost was silly. This
170 * is no longer the case. In this version only parts of responses
171 * that are actually supposed to be hostnames will be refused by
172 * default if quote-requiring characters are found.
176 * If you ask for an RR which contains domains which are actually
177 * encoded mailboxes, and don't ask for the _raw version, then adns
178 * returns the mailbox formatted suitably for an RFC822 recipient
179 * header field. The particular format used is that if the mailbox
180 * requires quoting according to the rules in RFC822 then the
181 * local-part is quoted in double quotes, which end at the next
182 * unescaped double quote. (\ is the escape char, and is doubled, and
183 * is used to escape only \ and ".) Otherwise the local-part is
184 * presented as-is. In any case this is followed by an @ and the
185 * domain. The domain will not contain any characters not legal in
186 * hostnames. adns will protect the application from local parts
187 * containing control characters - these appear to be legal according
188 * to RFC822 but are clearly a bad idea.
190 * If you ask for the domain with _raw then _no_ checking is done
191 * (even on the host part, regardless of adns_qf_quoteok_anshost), and
192 * you just get the domain name in master file format.
194 * If no mailbox is supplied the returned string will be `.' in either
201 /* locally induced errors */
203 adns_s_unknownrrtype,
206 adns_s_max_localfail= 29,
208 /* remotely induced errors, detected locally */
212 adns_s_invalidresponse,
213 adns_s_unknownformat,
215 adns_s_max_remotefail= 59,
217 /* remotely induced errors, reported by remote server to us */
218 adns_s_rcodeservfail,
219 adns_s_rcodeformaterror,
220 adns_s_rcodenotimplemented,
224 adns_s_max_tempfail= 99,
226 /* remote configuration errors */
227 adns_s_inconsistent, /* PTR gives domain whose A does not exist and match */
228 adns_s_prohibitedcname, /* CNAME found where eg A expected (not if _qf_loosecname) */
229 adns_s_answerdomaininvalid,
230 adns_s_answerdomaintoolong,
233 adns_s_max_misconfig= 199,
235 /* permanent problems with the query */
236 adns_s_querydomainwrong,
237 adns_s_querydomaininvalid,
238 adns_s_querydomaintoolong,
240 adns_s_max_misquery= 299,
242 /* permanent errors */
246 adns_s_max_permfail= 499
254 struct sockaddr_in inet;
261 int naddrs; /* temp fail => -1, perm fail => 0, s_ok => >0 */
272 } adns_rr_inthostaddr;
275 /* Used both for mx_raw, in which case i is the preference and str the domain,
276 * and for txt, in which case each entry has i for the `text' length,
277 * and str for the data (which will have had an extra nul appended
278 * so that if it was plain text it is now a null-terminated string).
285 adns_rr_intstr array[2];
286 } adns_rr_intstrpair;
290 unsigned long serial, refresh, retry, expire, minimum;
295 char *cname; /* always NULL if query was for CNAME records */
296 char *owner; /* only set if requested in query flags, and may be 0 on error anyway */
297 adns_rrtype type; /* guaranteed to be same as in query */
298 time_t expires; /* expiry time, defined only if _s_ok, nxdomain or nodata. NOT TTL! */
299 int nrrs, rrsz; /* nrrs is 0 if an error occurs */
302 unsigned char *bytes;
303 char *(*str); /* ns_raw, cname, ptr, ptr_raw */
304 adns_rr_intstr *(*manyistr); /* txt (list of strings ends with i=-1, str=0) */
305 adns_rr_addr *addr; /* addr */
306 struct in_addr *inaddr; /* a */
307 adns_rr_hostaddr *hostaddr; /* ns */
308 adns_rr_intstrpair *intstrpair; /* hinfo */
309 adns_rr_strpair *strpair; /* rp, rp_raw */
310 adns_rr_inthostaddr *inthostaddr; /* mx */
311 adns_rr_intstr *intstr; /* mx_raw */
312 adns_rr_soa *soa; /* soa, soa_raw */
316 /* Memory management:
317 * adns_state and adns_query are actually pointers to malloc'd state;
318 * On submission questions are copied, including the owner domain;
319 * Answers are malloc'd as a single piece of memory; pointers in the
320 * answer struct point into further memory in the answer.
322 * Must always be non-null pointer;
323 * If *query_io is 0 to start with then any query may be returned;
324 * If *query_io is !0 adns_query then only that query may be returned.
325 * If the call is successful, *query_io, *answer_r, and *context_r
328 * Return values are 0 or an errno value.
330 * For _init, _init_strcfg, _submit and _synchronous, system errors
331 * (eg, failure to create sockets, malloc failure, etc.) return errno
334 * For _wait and _check failures are reported in the answer
335 * structure, and only 0, ESRCH or (for _check) EAGAIN is
336 * returned: if no (appropriate) requests are done adns_check returns
337 * EAGAIN; if no (appropriate) requests are outstanding both
338 * adns_query and adns_wait return ESRCH.
340 * Additionally, _wait can return EINTR if you set adns_if_eintr.
342 * All other errors (nameserver failure, timed out connections, &c)
343 * are returned in the status field of the answer. After a
344 * successful _wait or _check, if status is nonzero then nrrs will be
345 * 0, otherwise it will be >0. type will always be the type
349 int adns_init(adns_state *newstate_r, adns_initflags flags,
350 FILE *diagfile /*0=>stderr*/);
352 int adns_init_strcfg(adns_state *newstate_r, adns_initflags flags,
353 FILE *diagfile /*0=>discard*/, const char *configtext);
356 * adns_init reads /etc/resolv.conf, which is expected to be (broadly
357 * speaking) in the format expected by libresolv, and then
358 * /etc/resolv-adns.conf if it exists. adns_init_strcfg is instead
359 * passed a string which is interpreted as if it were the contents of
360 * resolv.conf or resolv-adns.conf. In general, configuration which
361 * is set later overrides any that is set earlier.
363 * Standard directives understood in resolv[-adns].conf:
365 * nameserver <address>
366 * Must be followed by the IP address of a nameserver. Several
367 * nameservers may be specified, and they will be tried in the order
368 * found. There is a compiled in limit, currently 5, on the number
369 * of nameservers. (libresolv supports only 3 nameservers.)
371 * search <domain> ...
372 * Specifies the search list for queries which specify
373 * adns_qf_search. This is a list of domains to append to the query
374 * domain. The query domain will be tried as-is either before all
375 * of these or after them, depending on the ndots option setting
379 * This is present only for backward compatibility with obsolete
380 * versions of libresolv. It should not be used, and is interpreted
381 * by adns as if it were `search' - note that this is subtly
382 * different to libresolv's interpretation of this directive.
384 * sortlist <addr>/<mask> ...
385 * Should be followed by a sequence of IP-address and netmask pairs,
386 * separated by spaces. They may be specified as
387 * eg. 172.30.206.0/24 or 172.30.206.0/255.255.255.0. Currently up
388 * to 15 pairs may be specified (but note that libresolv only
389 * supports up to 10).
392 * Should followed by one or more options, separated by spaces.
393 * Each option consists of an option name, followed by optionally
394 * a colon and a value. Options are listed below.
396 * Non-standard directives understood in resolv[-adns].conf:
399 * Clears the list of nameservers, so that further nameserver lines
400 * start again from the beginning.
403 * The specified file will be read.
405 * Additionally, adns will ignore lines in resolv[-adns].conf which
408 * Standard options understood:
411 * Enables debugging output from the resolver, which will be written
415 * Affects whether queries with adns_qf_search will be tried first
416 * without adding domains from the searchlist, or whether the bare
417 * query domain will be tried last. Queries which contain at least
418 * <count> dots will be tried bare first. The default is 1.
420 * Non-standard options understood:
425 * Changes the consistency checking frequency; this overrides the
426 * setting of adns_if_check_entex, adns_if_check_freq, or neither,
427 * in the flags passed to adns_init.
429 * There are a number of environment variables which can modify the
430 * behaviour of adns. They take effect only if adns_init is used, and
431 * the caller of adns_init can disable them using adns_if_noenv. In
432 * each case there is both a FOO and an ADNS_FOO; the latter is
433 * interpreted later so that it can override the former. Unless
434 * otherwise stated, environment variables are interpreted after
435 * resolv[-adns].conf are read, in the order they are listed here.
437 * RES_CONF, ADNS_RES_CONF
438 * A filename, whose contets are in the format of resolv.conf.
440 * RES_CONF_TEXT, ADNS_RES_CONF_TEXT
441 * A string in the format of resolv.conf.
443 * RES_OPTIONS, ADNS_RES_OPTIONS
444 * These are parsed as if they appeared in the `options' line of a
445 * resolv.conf. In addition to being parsed at this point in the
446 * sequence, they are also parsed at the very beginning before
447 * resolv.conf or any other environment variables are read, so that
448 * any debug option can affect the processing of the configuration.
450 * LOCALDOMAIN, ADNS_LOCALDOMAIN
451 * These are interpreted as if their contents appeared in a `search'
452 * line in resolv.conf.
455 int adns_synchronous(adns_state ads,
458 adns_queryflags flags,
459 adns_answer **answer_r);
461 /* NB: if you set adns_if_noautosys then _submit and _check do not
462 * make any system calls; you must use some of the asynch-io event
463 * processing functions to actually get things to happen.
466 int adns_submit(adns_state ads,
469 adns_queryflags flags,
471 adns_query *query_r);
473 /* The owner should be quoted in master file format. */
475 int adns_check(adns_state ads,
476 adns_query *query_io,
477 adns_answer **answer_r,
480 int adns_wait(adns_state ads,
481 adns_query *query_io,
482 adns_answer **answer_r,
485 /* same as adns_wait but uses poll(2) internally */
486 int adns_wait_poll(adns_state ads,
487 adns_query *query_io,
488 adns_answer **answer_r,
491 void adns_cancel(adns_query query);
493 /* The adns_query you get back from _submit is valid (ie, can be
494 * legitimately passed into adns functions) until it is returned by
495 * adns_check or adns_wait, or passed to adns_cancel. After that it
496 * must not be used. You can rely on it not being reused until the
497 * first adns_submit or _transact call using the same adns_state after
498 * it became invalid, so you may compare it for equality with other
499 * query handles until you next call _query or _transact.
501 * _submit and _synchronous return ENOSYS if they don't understand the
505 int adns_submit_reverse(adns_state ads,
506 const struct sockaddr *addr,
508 adns_queryflags flags,
510 adns_query *query_r);
511 /* type must be _r_ptr or _r_ptr_raw. _qf_search is ignored.
512 * addr->sa_family must be AF_INET or you get ENOSYS.
515 int adns_submit_reverse_any(adns_state ads,
516 const struct sockaddr *addr,
519 adns_queryflags flags,
521 adns_query *query_r);
522 /* For RBL-style reverse `zone's; look up
523 * <reversed-address>.<zone>
524 * Any type is allowed. _qf_search is ignored.
525 * addr->sa_family must be AF_INET or you get ENOSYS.
528 void adns_finish(adns_state ads);
529 /* You may call this even if you have queries outstanding;
530 * they will be cancelled.
534 void adns_forallqueries_begin(adns_state ads);
535 adns_query adns_forallqueries_next(adns_state ads, void **context_r);
536 /* Iterator functions, which you can use to loop over the outstanding
537 * (submitted but not yet successfuly checked/waited) queries.
539 * You can only have one iteration going at once. You may call _begin
540 * at any time; after that, an iteration will be in progress. You may
541 * only call _next when an iteration is in progress - anything else
542 * may coredump. The iteration remains in progress until _next
543 * returns 0, indicating that all the queries have been walked over,
544 * or ANY other adns function is called with the same adns_state (or a
545 * query in the same adns_state). There is no need to explicitly
546 * finish an iteration.
548 * context_r may be 0. *context_r may not be set when _next returns 0.
551 void adns_checkconsistency(adns_state ads, adns_query qu);
552 /* Checks the consistency of adns's internal data structures.
553 * If any error is found, the program will abort().
554 * You may pass 0 for qu; if you pass non-null then additional checks
555 * are done to make sure that qu is a valid query.
559 * Example expected/legal calling sequence for submit/check/wait:
565 * adns_check 3 -> EAGAIN
573 * Entrypoints for generic asynch io:
574 * (these entrypoints are not very useful except in combination with *
575 * some of the other I/O model calls which can tell you which fds to
578 * Note that any adns call may cause adns to open and close fds, so
579 * you must call beforeselect or beforepoll again just before
580 * blocking, or you may not have an up-to-date list of it's fds.
583 int adns_processany(adns_state ads);
584 /* Gives adns flow-of-control for a bit. This will never block, and
585 * can be used with any threading/asynch-io model. If some error
586 * occurred which might cause an event loop to spin then the errno
590 int adns_processreadable(adns_state ads, int fd, const struct timeval *now);
591 int adns_processwriteable(adns_state ads, int fd, const struct timeval *now);
592 int adns_processexceptional(adns_state ads, int fd, const struct timeval *now);
593 /* Gives adns flow-of-control so that it can process incoming data
594 * from, or send outgoing data via, fd. Very like _processany. If it
595 * returns zero then fd will no longer be readable or writeable
596 * (unless of course more data has arrived since). adns will _only_
597 * use that fd and only in the manner specified, regardless of whether
598 * adns_if_noautosys was specified.
600 * adns_processexceptional should be called when select(2) reports an
601 * exceptional condition, or poll(2) reports POLLPRI.
603 * It is fine to call _processreabable or _processwriteable when the
604 * fd is not ready, or with an fd that doesn't belong to adns; it will
605 * then just return 0.
607 * If some error occurred which might prevent an event loop to spin
608 * then the errno value is returned.
611 void adns_processtimeouts(adns_state ads, const struct timeval *now);
612 /* Gives adns flow-of-control so that it can process any timeouts
613 * which might have happened. Very like _processreadable/writeable.
615 * now may be 0; if it isn't, *now must be the current time, recently
616 * obtained from gettimeofday.
619 void adns_firsttimeout(adns_state ads,
620 struct timeval **tv_mod, struct timeval *tv_buf,
622 /* Asks adns when it would first like the opportunity to time
623 * something out. now must be the current time, from gettimeofday.
625 * If tv_mod points to 0 then tv_buf must be non-null, and
626 * _firsttimeout will fill in *tv_buf with the time until the first
627 * timeout, and make *tv_mod point to tv_buf. If adns doesn't have
628 * anything that might need timing out it will leave *tv_mod as 0.
630 * If *tv_mod is not 0 then tv_buf is not used. adns will update
631 * *tv_mod if it has any earlier timeout, and leave it alone if it
634 * This call will not actually do any I/O, or change the fds that adns
635 * is using. It always succeeds and never blocks.
638 void adns_globalsystemfailure(adns_state ads);
639 /* If serious problem(s) happen which globally affect your ability to
640 * interact properly with adns, or adns's ability to function
641 * properly, you or adns can call this function.
643 * All currently outstanding queries will be made to fail with
644 * adns_s_systemfail, and adns will close any stream sockets it has
647 * This is used by adns, for example, if gettimeofday() fails.
648 * Without this the program's event loop might start to spin !
650 * This call will never block.
654 * Entrypoints for select-loop based asynch io:
657 void adns_beforeselect(adns_state ads, int *maxfd, fd_set *readfds,
658 fd_set *writefds, fd_set *exceptfds,
659 struct timeval **tv_mod, struct timeval *tv_buf,
660 const struct timeval *now);
661 /* Find out file descriptors adns is interested in, and when it would
662 * like the opportunity to time something out. If you do not plan to
663 * block then tv_mod may be 0. Otherwise, tv_mod and tv_buf are as
664 * for adns_firsttimeout. readfds, writefds, exceptfds and maxfd_io may
667 * If now is not 0 then this will never actually do any I/O, or change
668 * the fds that adns is using or the timeouts it wants. In any case
669 * it won't block, and it will set the timeout to zero if a query
670 * finishes in _beforeselect.
673 void adns_afterselect(adns_state ads, int maxfd, const fd_set *readfds,
674 const fd_set *writefds, const fd_set *exceptfds,
675 const struct timeval *now);
676 /* Gives adns flow-of-control for a bit; intended for use after
677 * select. This is just a fancy way of calling adns_processreadable/
678 * writeable/timeouts as appropriate, as if select had returned the
679 * data being passed. Always succeeds.
683 * Example calling sequence:
685 * adns_init _noautosys
691 * adns_submit / adns_check
697 * Entrypoints for poll-loop based asynch io:
701 /* In case your system doesn't have it or you forgot to include
702 * <sys/poll.h>, to stop the following declarations from causing
703 * problems. If your system doesn't have poll then the following
704 * entrypoints will not be defined in libadns. Sorry !
707 int adns_beforepoll(adns_state ads, struct pollfd *fds, int *nfds_io, int *timeout_io,
708 const struct timeval *now);
709 /* Finds out which fd's adns is interested in, and when it would like
710 * to be able to time things out. This is in a form suitable for use
713 * On entry, usually fds should point to at least *nfds_io structs.
714 * adns will fill up to that many structs will information for poll,
715 * and record in *nfds_io how many structs it filled. If it wants to
716 * listen for more structs then *nfds_io will be set to the number
717 * required and _beforepoll will return ERANGE.
719 * You may call _beforepoll with fds==0 and *nfds_io 0, in which case
720 * adns will fill in the number of fds that it might be interested in
721 * in *nfds_io, and always return either 0 (if it is not interested in
722 * any fds) or ERANGE (if it is).
724 * NOTE that (unless now is 0) adns may acquire additional fds
725 * from one call to the next, so you must put adns_beforepoll in a
726 * loop, rather than assuming that the second call (with the buffer
727 * size requested by the first) will not return ERANGE.
729 * adns only ever sets POLLIN, POLLOUT and POLLPRI in its pollfd
730 * structs, and only ever looks at those bits. POLLPRI is required to
731 * detect TCP Urgent Data (which should not be used by a DNS server)
732 * so that adns can know that the TCP stream is now useless.
734 * In any case, *timeout_io should be a timeout value as for poll(2),
735 * which adns will modify downwards as required. If the caller does
736 * not plan to block then *timeout_io should be 0 on entry, or
737 * alternatively, timeout_io may be 0. (Alternatively, the caller may
738 * use _beforeselect with timeout_io==0 to find out about file
739 * descriptors, and use _firsttimeout is used to find out when adns
740 * might want to time something out.)
742 * adns_beforepoll will return 0 on success, and will not fail for any
743 * reason other than the fds buffer being too small (ERANGE).
745 * This call will never actually do any I/O. If you supply the
746 * current time it will not change the fds that adns is using or the
749 * In any case this call won't block.
752 #define ADNS_POLLFDS_RECOMMENDED 2
753 /* If you allocate an fds buf with at least RECOMMENDED entries then
754 * you are unlikely to need to enlarge it. You are recommended to do
755 * so if it's convenient. However, you must be prepared for adns to
756 * require more space than this.
759 void adns_afterpoll(adns_state ads, const struct pollfd *fds, int nfds,
760 const struct timeval *now);
761 /* Gives adns flow-of-control for a bit; intended for use after
762 * poll(2). fds and nfds should be the results from poll(). pollfd
763 * structs mentioning fds not belonging to adns will be ignored.
767 adns_status adns_rr_info(adns_rrtype type,
768 const char **rrtname_r, const char **fmtname_r,
770 const void *datap, char **data_r);
772 * Get information about a query type, or convert reply data to a
773 * textual form. type must be specified, and the official name of the
774 * corresponding RR type will be returned in *rrtname_r, and
775 * information about the processing style in *fmtname_r. The length
776 * of the table entry in an answer for that type will be returned in
777 * in *len_r. Any or all of rrtname_r, fmtname_r and len_r may be 0.
778 * If fmtname_r is non-null then *fmtname_r may be null on return,
779 * indicating that no special processing is involved.
781 * data_r be must be non-null iff datap is. In this case *data_r will
782 * be set to point to a string pointing to a representation of the RR
783 * data in master file format. (The owner name, timeout, class and
784 * type will not be present - only the data part of the RR.) The
785 * memory will have been obtained from malloc() and must be freed by
788 * Usually this routine will succeed. Possible errors include:
790 * adns_s_rrtypeunknown
791 * adns_s_invaliddata (*datap contained garbage)
792 * If an error occurs then no memory has been allocated,
793 * and *rrtname_r, *fmtname_r, *len_r and *data_r are undefined.
795 * There are some adns-invented data formats which are not official
796 * master file formats. These include:
798 * Mailboxes if __qtf_mail822: these are just included as-is.
800 * Addresses (adns_rr_addr): these may be of pretty much any type.
801 * The representation is in two parts: first, a word for the address
802 * family (ie, in AF_XXX, the XXX), and then one or more items for the
803 * address itself, depending on the format. For an IPv4 address the
804 * syntax is INET followed by the dotted quad (from inet_ntoa).
805 * Currently only IPv4 is supported.
807 * Text strings (as in adns_rr_txt) appear inside double quotes, and
808 * use \" and \\ to represent " and \, and \xHH to represent
809 * characters not in the range 32-126.
811 * Hostname with addresses (adns_rr_hostaddr): this consists of the
812 * hostname, as usual, followed by the adns_status value, as an
813 * abbreviation, and then a descriptive string (encoded as if it were
814 * a piece of text), for the address lookup, followed by zero or more
815 * addresses enclosed in ( and ). If the result was a temporary
816 * failure, then a single ? appears instead of the ( ). If the
817 * result was a permanent failure then an empty pair of parentheses
818 * appears (which a space in between). For example, one of the NS
819 * records for greenend.org.uk comes out like
820 * ns.chiark.greenend.org.uk ok "OK" ( INET 195.224.76.132 )
821 * an MX referring to a nonexistent host might come out like:
822 * 50 sun2.nsfnet-relay.ac.uk nxdomain "No such domain" ( )
823 * and if nameserver information is not available you might get:
824 * dns2.spong.dyn.ml.org timeout "DNS query timed out" ?
827 const char *adns_strerror(adns_status st);
828 const char *adns_errabbrev(adns_status st);
829 const char *adns_errtypeabbrev(adns_status st);
830 /* Like strerror but for adns_status values. adns_errabbrev returns
831 * the abbreviation of the error - eg, for adns_s_timeout it returns
832 * "timeout". adns_errtypeabbrev returns the abbreviation of the
833 * error class: ie, for values up to adns_s_max_XXX it will return the
834 * string XXX. You MUST NOT call these functions with status values
835 * not returned by the same adns library.
839 } /* end of extern "C" */