Document base modes

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

diff --git a/include/socketengine_select.h b/include/socketengine_select.h
index bbd9b78dda56acc313d9af4dcd85e488088ba033..a6db96ee5638c0f4d40f2dbc7d872055d22bfb77 100644 (file)
--- a/include/socketengine_select.h
+++ b/include/socketengine_select.h
@@ -20,18 +20,32 @@
 #include <vector>
 #include <string>
 #include <map>
+#include <sys/select.h>
 #include "inspircd_config.h"
 #include "globals.h"
 #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 int GetMaxFds();
@@ -41,10 +55,14 @@ public:
        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(InspIRCd* Instance); }
 };
 
 #endif