* - adns user-visible API (single-threaded, without any locking)
*/
/*
- * This file is part of adns, which is Copyright (C) 1997-1999 Ian Jackson
+ *
+ * This file is
+ * Copyright (C) 1997-1999 Ian Jackson <ian@davenant.greenend.org.uk>
+ *
+ * It is part of adns, which is
+ * Copyright (C) 1997-1999 Ian Jackson <ian@davenant.greenend.org.uk>
+ * Copyright (C) 1999 Tony Finch <dot@dotat.at>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
+ *
+ *
+ * For the benefit of certain LGPL'd `omnibus' software which provides
+ * a uniform interface to various things including adns, I make the
+ * following additional licence. I do this because the GPL would
+ * otherwise force either the omnibus software to be GPL'd or for the
+ * adns-using part to be distributed separately.
+ *
+ * So, you may also redistribute and/or modify adns.h (but only the
+ * public header file adns.h and not any other part of adns) under the
+ * terms of the GNU Library General Public License as published by the
+ * Free Software Foundation; either version 2 of the License, or (at
+ * your option) any later version.
*
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software Foundation,
+ * Note that adns itself is GPL'd. Authors of adns-using applications
+ * with GPL-incompatible licences, and people who distribute adns with
+ * applications where the whole distribution is not GPL'd, are still
+ * likely to be in violation of the GPL. Anyone who wants to do this
+ * should contact Ian Jackson. Please note that to avoid encouraging
+ * people to infringe the GPL as it applies the body of adns, I think
+ * that if you take advantage of the special exception to redistribute
+ * just adns.h under the LGPL, you should retain this paragraph in its
+ * place in the appropriate copyright statements.
+ *
+ *
+ * You should have received a copy of the GNU General Public License,
+ * or the GNU Library General Public License, as appropriate, along
+ * with this program; if not, write to the Free Software Foundation,
* Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
+ *
* $Id$
*/
/* permanent errors */
adns_s_nxdomain,
- adns_s_nodata
+ adns_s_nodata,
+
+ adns_s_max_permfail= 499
} adns_status;
* values.
*
* For _wait and _check failures are reported in the answer
- * structure, and only 0, ESRCH or (for _check) EWOULDBLOCK is
+ * structure, and only 0, ESRCH or (for _check) EAGAIN is
* returned: if no (appropriate) requests are done adns_check returns
- * EWOULDBLOCK; if no (appropriate) requests are outstanding both
+ * EAGAIN; if no (appropriate) requests are outstanding both
* adns_query and adns_wait return ESRCH.
*
* Additionally, _wait can return EINTR if you set adns_if_eintr.
* requested.
*/
-int adns_init(adns_state *newstate_r, adns_initflags flags,
+int adns_init(adns_state *newstate_r, int flags /*adns_initflags*/,
FILE *diagfile /*0=>stderr*/);
-int adns_init_strcfg(adns_state *newstate_r, adns_initflags flags,
+int adns_init_strcfg(adns_state *newstate_r, int flags /*adns_initflags*/,
FILE *diagfile /*0=>discard*/, const char *configtext);
/* Configuration:
int adns_synchronous(adns_state ads,
const char *owner,
adns_rrtype type,
- adns_queryflags flags,
+ int flags /*adns_queryflags*/,
adns_answer **answer_r);
/* NB: if you set adns_if_noautosys then _submit and _check do not
int adns_submit(adns_state ads,
const char *owner,
adns_rrtype type,
- adns_queryflags flags,
+ int flags /*adns_queryflags*/,
void *context,
adns_query *query_r);
+/* The owner should be quoted in master file format. */
+
int adns_check(adns_state ads,
adns_query *query_io,
adns_answer **answer_r,
int adns_submit_reverse(adns_state ads,
const struct sockaddr *addr,
adns_rrtype type,
- adns_queryflags flags,
+ int flags /*adns_queryflags*/,
void *context,
adns_query *query_r);
-/* type must be _r_ptr or _r_ptr_raw. _qf_search is ignored. */
+/* type must be _r_ptr or _r_ptr_raw. _qf_search is ignored.
+ * addr->sa_family must be AF_INET or you get ENOSYS.
+ */
void adns_finish(adns_state ads);
/* You may call this even if you have queries outstanding;
* adns_submit 2
* adns_submit 3
* adns_wait 1
- * adns_check 3 -> EWOULDBLOCK
+ * adns_check 3 -> EAGAIN
* adns_wait 2
* adns_wait 3
* ....
int *len_r,
const void *datap, char **data_r);
/*
-
* Get information about a query type, or convert reply data to a
* textual form. type must be specified, and the official name of the
* corresponding RR type will be returned in *rrtname_r, and
const char *adns_strerror(adns_status st);
const char *adns_errabbrev(adns_status st);
+const char *adns_errtypeabbrev(adns_status st);
/* Like strerror but for adns_status values. adns_errabbrev returns
* the abbreviation of the error - eg, for adns_s_timeout it returns
- * "timeout". You MUST NOT call these functions with status values
+ * "timeout". adns_errtypeabbrev returns the abbreviation of the
+ * error class: ie, for values up to adns_s_max_XXX it will return the
+ * string XXX. You MUST NOT call these functions with status values
* not returned by the same adns library.
*/
~ianmdlvl / adns.git / blobdiff