X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fdns.h;h=63d5bb1fb78174a15b840d80a031164184044477;hb=8ed28d1f98d4d4c653201f0c4273e74dd8a122e6;hp=61c35b07305d5cbfb9000ef809fee28f9fc4a6c1;hpb=b7f823b059aa6f8133abf0a0d1895983ccd04590;p=user%2Fhenk%2Fcode%2Finspircd.git

diff --git a/include/dns.h b/include/dns.h
index 61c35b073..63d5bb1fb 100644
--- a/include/dns.h
+++ b/include/dns.h
@@ -28,14 +28,19 @@ struct dns_ip4list {
 	dns_ip4list *next;
 };
 
+
+/** The DNS class allows fast nonblocking resolution of hostnames
+ * and ip addresses. It is based heavily upon firedns by Ian Gulliver.
+ */
 class DNS
 {
 private:
-	char *result;
 	in_addr *binip;
-	int t,i;
+	char* result;
+	char localbuf[1024];
+	int t;
 	void dns_init();
-	unsigned int fd;
+	int myfd;
 	void dns_init_2(const char* dnsserver);
 	in_addr *dns_aton4(const char * const ipstring);
 	char *dns_ntoa4(const in_addr * const ip);
@@ -50,14 +55,46 @@ private:
 	char *dns_ntoa4_r(const in_addr * const ip);
 	char *dns_getresult_r(const int fd);
 public:
+	/** The default constructor uses dns addresses read from /etc/resolv.conf.
+	 * Please note that it will re-read /etc/resolv.conf for each copy of the
+	 * class you instantiate, causing disk access and slow lookups if you create
+	 * a lot of them. Consider passing the constructor a server address as a parameter
+	 * instead.
+	 */
 	DNS();
+	/** This constructor accepts a dns server address. The address must be in dotted
+	 * decimal form, e.g. 1.2.3.4.
+	 */
 	DNS(std::string dnsserver);
+	/** The destructor frees all used structures.
+	 */
 	~DNS();
+	/** This method will start the reverse lookup of an ip given in dotted decimal
+	 * format, e.g. 1.2.3.4, and returns true if the lookup was successfully
+	 * initiated.
+	 */
 	bool ReverseLookup(std::string ip);
+	/** This method will start the forward lookup of a hostname, e.g. www.inspircd.org,
+	 * and returns true if the lookup was successfully initiated.
+	 */
 	bool ForwardLookup(std::string host);
+	/** This method will return true when the lookup is completed. It uses poll internally
+	 * to determine the status of the socket.
+	 */
 	bool HasResult();
+	/** This method will return true if the lookup's fd matches the one provided
+	 */
+	bool HasResult(int fd);
+	/** This method returns the result of your query as a string, depending upon wether you
+	 * called DNS::ReverseLookup() or DNS::ForwardLookup.
+	 */
 	std::string GetResult();
+	std::string GetResultIP();
+	/** This method returns the file handle used by the dns query socket or zero if the
+	 * query is invalid for some reason, e.g. the dns server not responding.
+	 */
 	int GetFD();
+	void SetNS(std::string dnsserver);
 };
 
 #endif