X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fsocketengine_epoll.h;h=8e4d6308fb2d566152d99c8b70fea8fa9b04fde2;hb=d54fd9b1e6b31f69332a9241b5f17330c0ad61e0;hp=ddbeb6f4069fca2da89f49e7fc2f86b4d17071e1;hpb=3a6885d6a1d30f6e2eb9b1fcd20e949768267318;p=user%2Fhenk%2Fcode%2Finspircd.git

diff --git a/include/socketengine_epoll.h b/include/socketengine_epoll.h
index ddbeb6f40..8e4d6308f 100644
--- a/include/socketengine_epoll.h
+++ b/include/socketengine_epoll.h
@@ -27,25 +27,40 @@
 #include <sys/epoll.h>
 #define EP_DELAY 5
 
+class InspIRCd;
+
+/** A specialisation of the SocketEngine class, designed to use linux 2.6 epoll().
+ */
 class EPollEngine : public SocketEngine
 {
 private:
-	struct epoll_event events[MAX_DESCRIPTORS];     /* Up to 64k sockets for epoll */
+	/** These are used by epoll() to hold socket events
+	 */
+	struct epoll_event events[MAX_DESCRIPTORS];
 public:
-	EPollEngine();
+	/** Create a new EPollEngine
+	 * @param Instance The creator of this object
+	 */
+	EPollEngine(InspIRCd* Instance);
+	/** Delete an EPollEngine
+	 */
 	virtual ~EPollEngine();
-	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 EPollEngine(); }
+	/** Create a new instance of SocketEngine based on EpollEngine
+	 */
+	SocketEngine* Create(InspIRCd* Instance) { return new EPollEngine(Instance); }
 };
 
 #endif