Documented all of the functions in a basic manner here. More detail to follow

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

diff --git a/include/inspsocket.h b/include/inspsocket.h
index b644151dc06b7e3205a9f290c60425068100bc6a..ddb0baedb41074bda2571465fa321ac2b613a0a4 100644 (file)
--- a/include/inspsocket.h
+++ b/include/inspsocket.h
@@ -32,9 +32,15 @@ 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;
+class InspIRCd;
+
+using irc::sockets::insp_sockaddr;
+using irc::sockets::insp_inaddr;
+using irc::sockets::insp_ntoa;
+using irc::sockets::insp_aton;
 
 /**
  * InspSocket is an extendable socket class which modules
@@ -50,6 +56,7 @@ class InspSocket;
 class InspSocket : public Extensible
 {
  public:
+       InspIRCd* Instance;
 
        std::deque<std::string> outbuffer;
 
@@ -165,7 +172,7 @@ class InspSocket : public Extensible
         * The default constructor does nothing
         * and should not be used.
         */
-       InspSocket();
+       InspSocket(InspIRCd* SI);
 
        /**
         * This constructor is used to associate
@@ -175,7 +182,7 @@ class InspSocket : public Extensible
         * will be set with the given IP address
         * and placed in CONNECTED state.
         */
-       InspSocket(int newfd, const char* ip);
+       InspSocket(InspIRCd* SI, int newfd, const char* ip);
 
        /**
         * This constructor is used to create a new
@@ -188,7 +195,7 @@ class InspSocket : public Extensible
         * @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 &ipaddr, int port, bool listening, unsigned long maxtime);
+       InspSocket(InspIRCd* SI, const std::string &ipaddr, int port, bool listening, unsigned long maxtime);
 
        /**
         * This method is called when an outbound