Document ListenSocket class

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

diff --git a/include/inspsocket.h b/include/inspsocket.h
index d2a8ed522b2701717e435ecc48e3a674623e7804..3791aa3e02cfb6ea05d0a5db3d26cb0ee15f18b0 100644 (file)
--- a/include/inspsocket.h
+++ b/include/inspsocket.h
@@ -23,6 +23,7 @@
 #include "dns.h"
 #include "inspircd_config.h"
 #include "socket.h"
+#include "inspsocket.h"
 
 /**
  * States which a socket may be in
@@ -35,6 +36,12 @@ enum InspSocketState { I_DISCONNECTED, I_CONNECTING, I_CONNECTED, I_LISTENING, I
 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
@@ -47,17 +54,13 @@ class InspSocket;
  * and use the InspSocket constructors to establish connections
  * and bindings.
  */
-class InspSocket : public Extensible
+class InspSocket : public EventHandler
 {
  public:
+       InspIRCd* Instance;
 
        std::deque<std::string> outbuffer;
 
-       /**
-        * The file descriptor of this socket
-        */
-        int fd;
-
        /**
         * The hostname connected to
         */
@@ -165,7 +168,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 +178,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 +191,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
@@ -358,6 +361,10 @@ class InspSocket : public Extensible
         * memory reclaimed.
         */
        void MarkAsClosed();
+
+       void HandleEvent(EventType et);
+
+       bool Readable();
 };
 
 #endif