X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fsocketengine_select.h;h=f6c03409190c225ee6ad792584ca6e1512b77aed;hb=d54fd9b1e6b31f69332a9241b5f17330c0ad61e0;hp=b3f7479eeda5b9ab2b9ea929dfec39fdc9c07715;hpb=d17465716790010b6e3221f9ce49272110276ccf;p=user%2Fhenk%2Fcode%2Finspircd.git

diff --git a/include/socketengine_select.h b/include/socketengine_select.h
index b3f7479ee..f6c034091 100644
--- a/include/socketengine_select.h
+++ b/include/socketengine_select.h
@@ -28,26 +28,41 @@
 
 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:
+	/** 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(InspIRCd* Instance) { return new SelectEngine(InspIRCd* Instance); }
+	/** Create a new instance of SocketEngine based on SelectEngine
+	 */
+	SocketEngine* Create(InspIRCd* Instance) { return new SelectEngine(Instance); }
 };
 
 #endif