Purely a documentation fix: PRIO_AFTER doesn't exist any more, it's PRIORITY_AFTER.

[user/henk/code/inspircd.git] / include / dns.h

diff --git a/include/dns.h b/include/dns.h
index 3deb7d3c886b379289950015ac0a4bf9de7da0d0..4f577366bae4fb4bbe042c418f4028f3bd9e7812 100644 (file)
--- a/include/dns.h
+++ b/include/dns.h
@@ -2,8 +2,8 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ * See: http://wiki.inspircd.org/Credits
  *
  * This program is free but copyrighted software; see
  *            the file COPYING for details.
@@ -32,21 +32,9 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 #ifndef _DNS_H
 #define _DNS_H
 
-#include <string>
-#include "inspircd_config.h"
-#include "base.h"
-#include "socketengine.h"
 #include "socket.h"
-#include "hash_map.h"
 #include "hashcomp.h"
 
-using namespace std;
-using irc::sockets::insp_aton;
-using irc::sockets::insp_ntoa;
-using irc::sockets::insp_sockaddr;
-using irc::sockets::insp_inaddr;
-
-class InspIRCd;
 class Module;
 
 /**
@@ -84,7 +72,7 @@ typedef std::pair<unsigned char*, std::string> DNSInfo;
 
 /** Cached item stored in the query cache.
  */
-class CoreExport CachedQuery
+class CoreExport CachedQuery : public classbase
 {
  public:
        /** The cached result data, an IP or hostname
@@ -129,10 +117,9 @@ enum ResolverError
        RESOLVER_NOERROR        =       0,
        RESOLVER_NSDOWN         =       1,
        RESOLVER_NXDOMAIN       =       2,
-       RESOLVER_NOTREADY       =       3,
-       RESOLVER_BADIP          =       4,
-       RESOLVER_TIMEOUT        =       5,
-       RESLOVER_FORCEUNLOAD    =       6
+       RESOLVER_BADIP          =       3,
+       RESOLVER_TIMEOUT        =       4,
+       RESOLVER_FORCEUNLOAD    =       5
 };
 
 /**
@@ -155,32 +142,39 @@ struct ResourceRecord;
  */
 enum QueryType
 {
-       DNS_QUERY_NONE  = 0,            /* Uninitialized Query */
-       DNS_QUERY_A     = 1,            /* 'A' record: an ipv4 address */
-       DNS_QUERY_CNAME = 5,            /* 'CNAME' record: An alias */
-       DNS_QUERY_PTR   = 12,           /* 'PTR' record: a hostname */
-       DNS_QUERY_AAAA  = 28,           /* 'AAAA' record: an ipv6 address */
-
-       DNS_QUERY_PTR4  = 0xFFFD,       /* Force 'PTR' to use IPV4 scemantics */
-       DNS_QUERY_PTR6  = 0xFFFE,       /* Force 'PTR' to use IPV6 scemantics */
+       /** Uninitialized Query */
+       DNS_QUERY_NONE  = 0,
+       /** 'A' record: an ipv4 address */
+       DNS_QUERY_A     = 1,
+       /** 'CNAME' record: An alias */
+       DNS_QUERY_CNAME = 5,
+       /** 'PTR' record: a hostname */
+       DNS_QUERY_PTR   = 12,
+       /** 'AAAA' record: an ipv6 address */
+       DNS_QUERY_AAAA  = 28,
+
+       /** Force 'PTR' to use IPV4 scemantics */
+       DNS_QUERY_PTR4  = 0xFFFD,
+       /** Force 'PTR' to use IPV6 scemantics */
+       DNS_QUERY_PTR6  = 0xFFFE
 };
 
 #ifdef IPV6
 const QueryType DNS_QUERY_FORWARD = DNS_QUERY_AAAA;
-const QueryType DNS_QUERY_REVERSE = DNS_QUERY_PTR;
 #else
 const QueryType DNS_QUERY_FORWARD = DNS_QUERY_A;
-const QueryType DNS_QUERY_REVERSE = DNS_QUERY_PTR;
 #endif
-
+const QueryType DNS_QUERY_REVERSE = DNS_QUERY_PTR;
 /**
  * Used internally to force PTR lookups to use a certain protocol scemantics,
  * e.g. x.x.x.x.in-addr.arpa for v4, and *.ip6.arpa for v6.
  */
 enum ForceProtocol
 {
-       PROTOCOL_IPV4 = 0,      /* Forced to use ipv4 */
-       PROTOCOL_IPV6 = 1       /* Forced to use ipv6 */
+       /** Forced to use ipv4 */
+       PROTOCOL_IPV4 = 0,
+       /** Forced to use ipv6 */
+       PROTOCOL_IPV6 = 1
 };
 
 /**
@@ -233,6 +227,7 @@ class CoreExport Resolver : public Extensible
         * Time left before cache expiry
         */
        int time_left;
+
  public:
        /**
         * Initiate DNS lookup. Your class should not attempt to delete or free these
@@ -281,6 +276,7 @@ class CoreExport Resolver : public Extensible
         * The default destructor does nothing.
         */
        virtual ~Resolver();
+
        /**
         * When your lookup completes, this method will be called.
         * @param result The resulting DNS lookup, either an IP address or a hostname.
@@ -290,6 +286,7 @@ class CoreExport Resolver : public Extensible
         * from the DNS server.
         */
        virtual void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached) = 0;
+
        /**
         * If an error occurs (such as NXDOMAIN, no domain name found) then this method
         * will be called.
@@ -297,6 +294,7 @@ class CoreExport Resolver : public Extensible
         * @param errormessage The error text of the error that occured.
         */
        virtual void OnError(ResolverError e, const std::string &errormessage);
+
        /**
         * Returns the id value of this class. This is primarily used by the core
         * to determine where in various tables to place a pointer to your class, but it
@@ -306,10 +304,12 @@ class CoreExport Resolver : public Extensible
         * this method will return -1.
         */
        int GetId();
+
        /**
         * Returns the creator module, or NULL
         */
        Module* GetCreator();
+
        /**
         * If the result is a cached result, this triggers the objects
         * OnLookupComplete. This is done because it is not safe to call
@@ -372,9 +372,16 @@ class CoreExport DNS : public EventHandler
         * Server address being used currently
         */
        int socketfamily;
+
 #ifdef IPV6
+       /**
+        * IPV6 server address
+        */
        in6_addr myserver6;
 #endif
+       /**
+        * IPV4 server address
+        */
        in_addr myserver4;
 
        /**
@@ -419,7 +426,7 @@ class CoreExport DNS : public EventHandler
         * e.g. use ipv6 reverse lookup when built for ipv6,
         * or ipv4 lookup when built for ipv4.
         */
-       int GetName(const insp_inaddr* ip);
+       int GetName(const irc::sockets::insp_inaddr* ip);
 
        /**
         * Start lookup of a hostname from an ip, but