Wahhhhhhhhhhhh bwahahaha. Mass commit to tidy up tons of messy include lists

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

diff --git a/include/socketengine_select.h b/include/socketengine_select.h
index 442f8c7548e3afaae2ca127126bbb80dc4ccc620..f6c03409190c225ee6ad792584ca6e1512b77aed 100644 (file)
--- a/include/socketengine_select.h
+++ b/include/socketengine_select.h
@@ -26,26 +26,43 @@
 #include "inspircd.h"
 #include "socketengine.h"
 
+class InspIRCd;
+
+/** A specialisation of the SocketEngine class, designed to use traditional select().
+ */
 class SelectEngine : public SocketEngine
 {
 private:
-       std::map<int,int> fds;          /* List of file descriptors being monitored */
-       fd_set wfdset, rfdset;          /* Readable and writeable sets for select() */
+       /** Because select() does not track an fd list for us between calls, we have one of our own
+        */
+       std::map<int,int> fds;
+       /** The read set and write set, populated before each call to select().
+        */
+       fd_set wfdset, rfdset;
 public:
-       SelectEngine();
+       /** Create a new SelectEngine
+        * @param Instance The creator of this object
+        */
+       SelectEngine(InspIRCd* Instance);
+       /** Delete a SelectEngine
+        */
        virtual ~SelectEngine();
-       virtual bool AddFd(int fd, bool readable, char type);
+       virtual bool AddFd(EventHandler* eh);
        virtual int GetMaxFds();
        virtual int GetRemainingFds();
-       virtual bool DelFd(int fd);
-       virtual int Wait(int* fdlist);
+       virtual bool DelFd(EventHandler* eh);
+       virtual int DispatchEvents();
        virtual std::string GetName();
 };
 
+/** Creates a SocketEngine
+ */
 class SocketEngineFactory
 {
 public:
-       SocketEngine* Create() { return new SelectEngine(); }
+       /** Create a new instance of SocketEngine based on SelectEngine
+        */
+       SocketEngine* Create(InspIRCd* Instance) { return new SelectEngine(Instance); }
 };
 
 #endif