Tons of comments

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

diff --git a/include/inspsocket.h b/include/inspsocket.h
index 077f20a6563521805ba5c3339de92e355adb5860..d2a8ed522b2701717e435ecc48e3a674623e7804 100644 (file)
--- a/include/inspsocket.h
+++ b/include/inspsocket.h
@@ -32,7 +32,7 @@ enum InspSocketState { I_DISCONNECTED, I_CONNECTING, I_CONNECTED, I_LISTENING, I
 /**
  * Error types which a socket may exhibit
  */
-enum InspSocketError { I_ERR_TIMEOUT, I_ERR_SOCKET, I_ERR_CONNECT, I_ERR_BIND, I_ERR_RESOLVE, I_ERR_WRITE };
+enum InspSocketError { I_ERR_TIMEOUT, I_ERR_SOCKET, I_ERR_CONNECT, I_ERR_BIND, I_ERR_RESOLVE, I_ERR_WRITE, I_ERR_NOMOREFDS };
 
 class InspSocket;
 
@@ -58,10 +58,6 @@ class InspSocket : public Extensible
         */
         int fd;
 
-       /**
-        * The resolver for this socket
-        */
-
        /**
         * The hostname connected to
         */
@@ -184,15 +180,15 @@ class InspSocket : public Extensible
        /**
         * This constructor is used to create a new
         * socket, either listening for connections, or an outbound connection to another host.
-        * Note that if you specify a hostname in the 'host' parameter, then there will be an extra
-        * step involved (a nonblocking DNS lookup) which will cause your connection to be established
-        * slower than if it was an IP. Therefore, use an IP address where it is available instead.
-        * @param host The hostname to connect to, or bind to
+        * Note that if you specify a hostname in the 'ipaddr' parameter, this class will not
+        * connect. You must resolve your hostnames before passing them to InspSocket. To do so,
+        * you should use the nonblocking class 'Resolver'.
+        * @param ipaddr The IP to connect to, or bind to
         * @param port The port number to connect to, or bind to
         * @param listening true to listen on the given host:port pair, or false to connect to them
         * @param maxtime Number of seconds to wait, if connecting, before the connection times out and an OnTimeout() event is generated
         */
-       InspSocket(const std::string &host, int port, bool listening, unsigned long maxtime);
+       InspSocket(const std::string &ipaddr, int port, bool listening, unsigned long maxtime);
 
        /**
         * This method is called when an outbound