Copyright dates fixed; various TODOs added.

[adns.git] / src / adns.h

diff --git a/src/adns.h b/src/adns.h
index a87767a98be468d9c6c8110420b95bd1675a1a48..1b3e1d3bf507a5a706c489d28d0e66b59a26899d 100644 (file)
--- a/src/adns.h
+++ b/src/adns.h
@@ -1,11 +1,5 @@
 /*
- * Copyright (C)1998 Ian Jackson.
- * This version provided for review and comment only.
- *
- * $Id$
- */
-/*
- *  This file is part of adns, which is Copyright (C) 1997, 1998 Ian Jackson
+ *  This file is part of adns, which is Copyright (C) 1997-1999 Ian Jackson
  *  
  *  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
@@ -19,7 +13,9 @@
  *  
  *  You should have received a copy of the GNU General Public License
  *  along with this program; if not, write to the Free Software Foundation,
- *  Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. 
+ *  Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ *
+ *  $Id$
  */
 
 #ifndef ADNS_H_INCLUDED
@@ -30,6 +26,8 @@
 #include <sys/socket.h>
 #include <netinet/in.h>
 
+/* All struct in_addr anywhere in adns are in NETWORK byte order. */
+
 typedef struct adns__state *adns_state;
 typedef struct adns__query *adns_query;
 
@@ -102,29 +100,48 @@ typedef enum {
  */
 
 typedef enum {
-  /* fixme: think about error codes */
   adns_s_ok,
+
+  /* locally induced errors */
+  adns_s_nomemory,
+  adns_s_unknownrrtype,
+  
+  /* remotely induced errors, detected locally */
   adns_s_timeout,
-  adns_s_nolocalmem,
   adns_s_allservfail,
-  adns_s_servfail,
-  adns_s_notimplemented,
-  adns_s_refused,
-  adns_s_reasonunknown,
   adns_s_norecurse,
-  adns_s_serverfaulty,
-  adns_s_unknownreply,
-  adns_s_invaliddata,
+  adns_s_invalidresponse,
+  adns_s_unknownformat,
+  
+  /* remotely induced errors, reported by remote server to us */
+  adns_s_rcodeservfail,
+  adns_s_rcodeformaterror,
+  adns_s_rcodenotimplemented,
+  adns_s_rcoderefused,
+  adns_s_rcodeunknown,
+  
   adns_s_max_tempfail= 99,
-  adns_s_inconsistent, /* PTR gives domain whose A does not match */
-  adns_s_cname, /* CNAME found where data eg A expected (not if _qf_loosecname) */
-  adns_s_invalidanswerdomain,
-  /* fixme: implement _s_cname */
-  adns_s_max_remotemisconfig= 199,
+
+  /* remote configuration errors */
+  adns_s_inconsistent, /* PTR gives domain whose A does not exist and match */
+  adns_s_prohibitedcname, /* CNAME found where eg A expected (not if _qf_loosecname) */
+  adns_s_answerdomaininvalid,
+  adns_s_answerdomaintoolong,
+  adns_s_invaliddata,
+  
+  adns_s_max_misconfig= 199,
+
+  /* permanent problems with the query */
+  adns_s_querydomainwrong,
+  adns_s_querydomaininvalid,
+  adns_s_querydomaintoolong,
+  
+  adns_s_max_misquery= 299,
+
+  /* permanent errors */
   adns_s_nxdomain,
   adns_s_nodata,
-  adns_s_invalidquerydomain,
-  adns_s_domaintoolong,
+  
 } adns_status;
 
 typedef struct {
@@ -143,7 +160,7 @@ typedef struct {
 } adns_rr_hostaddr;
 
 typedef struct {
-  char *a, *b;
+  char *(array[2]);
 } adns_rr_strpair;
 
 typedef struct {
@@ -162,7 +179,11 @@ typedef struct {
 } adns_rr_intstr;
 
 typedef struct {
-  char *ns0, *rp;
+  adns_rr_intstr array[2];
+} adns_rr_intstrpair;
+
+typedef struct {
+  char *mname, *rname;
   unsigned long serial, refresh, retry, expire, minimum;
 } adns_rr_soa;
 
@@ -179,7 +200,8 @@ typedef struct {
     adns_rr_addr *addr;               /* addr */
     struct in_addr *inaddr;           /* a */
     adns_rr_hostaddr *hostaddr;       /* ns */
-    adns_rr_strpair *strpair;         /* hinfo ??fixme, rp, rp_raw */
+    adns_rr_intstrpair *intstrpair;   /* hinfo */
+    adns_rr_strpair *strpair;         /* rp, rp_raw */
     adns_rr_inthostaddr *inthostaddr; /* mx */
     adns_rr_intstr *intstr;           /* mx_raw */
     adns_rr_soa *soa;                 /* soa, soa_raw */
@@ -209,8 +231,11 @@ typedef struct {
  *  If no (appropriate) requests are outstanding adns_query and adns_wait return ESRCH;
  */
 
-/* fixme: separate parsing from instantiation */
-int adns_init(adns_state *newstate_r, adns_initflags flags, FILE *diagfile/*0=>stderr*/);
+int adns_init(adns_state *newstate_r, adns_initflags flags,
+             FILE *diagfile /*0=>stderr*/);
+
+int adns_init_strcfg(adns_state *newstate_r, adns_initflags flags,
+                    FILE *diagfile /*0=>discard*/, const char *configtext);
 
 int adns_synchronous(adns_state ads,
                     const char *owner,
@@ -239,10 +264,14 @@ int adns_wait(adns_state ads,
              adns_query *query_io,
              adns_answer **answer_r,
              void **context_r);
+/* fixme: merge _check and _wait into one func with flags wait and `remove'(?) */
+/* fixme: include TTL in answer somehow */
+/* fixme: multithreading/locking */
+/* fixme: easy way to get lists of fd's */
 
 void adns_cancel(adns_query query);
 
-int adns_finish(adns_state);
+void adns_finish(adns_state);
 /* You may call this even if you have queries outstanding;
  * they will be cancelled.
  */
@@ -316,7 +345,7 @@ adns_status adns_rr_info(adns_rrtype type,
  *
  * Usually this routine will succeed.  Possible errors include:
  *  adns_s_nomemory
- *  adns_s_notimplemented (RR type not known)
+ *  adns_s_rrtypeunknown
  *  adns_s_invaliddata (*datap contained garbage)
  * If an error occurs then no memory has been allocated,
  * and *rrtname_r, *fmtname_r, *len_r and *data_r are undefined.