As we have an enum for type, why not ..use it?

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

diff --git a/include/dns.h b/include/dns.h
index b00c57201f1062b0079052904f65fea830ad82b5..e93672f6755f6f77c873e830c52f13fb4b96ccf3 100644 (file)
--- a/include/dns.h
+++ b/include/dns.h
@@ -2,7 +2,7 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
  * See: http://www.inspircd.org/wiki/index.php/Credits
  *
  * This program is free but copyrighted software; see
@@ -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
@@ -155,14 +143,21 @@ 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
@@ -177,8 +172,10 @@ const QueryType DNS_QUERY_REVERSE = DNS_QUERY_PTR;
  */
 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
 };
 
 /**
@@ -231,6 +228,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
@@ -279,6 +277,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.
@@ -286,8 +285,11 @@ class CoreExport Resolver : public Extensible
         * result, this is the number of seconds remaining before refresh/expiry.
         * @param cached True if the result is a cached result, false if it was requested
         * from the DNS server.
+        * @param resultnum Result number, for records with multiple matching results.
+        * Normally, you will only want to act on this when the result is 0.
         */
-       virtual void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached) = 0;
+       virtual void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached, int resultnum = 0) = 0;
+
        /**
         * If an error occurs (such as NXDOMAIN, no domain name found) then this method
         * will be called.
@@ -295,6 +297,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
@@ -304,10 +307,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
@@ -370,9 +375,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;
 
        /**
@@ -417,7 +429,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
@@ -439,8 +451,9 @@ class CoreExport DNS : public EventHandler
        /**
         * Fetch the result string (an ip or host)
         * and/or an error message to go with it.
+        * @param resultnum Result number to fetch
         */
-       DNSResult GetResult();
+       DNSResult GetResult(int resultnum);
 
        /**
         * Handle a SocketEngine read event