From d9d4f8fdadc06d86daba2879423e555519971868 Mon Sep 17 00:00:00 2001 From: brain Date: Sat, 12 Aug 2006 01:13:40 +0000 Subject: Document some missing xline stuff Document the variants of SocketEngine for epoll, kqueue and select git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@4905 e03df62e-2008-0410-955e-edbf42e46eb7 --- include/socketengine_select.h | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) (limited to 'include/socketengine_select.h') diff --git a/include/socketengine_select.h b/include/socketengine_select.h index b3f7479ee..a6db96ee5 100644 --- a/include/socketengine_select.h +++ b/include/socketengine_select.h @@ -28,13 +28,24 @@ class InspIRCd; +/** A specialisation of the SocketEngine class, designed to use traditional select(). + */ class SelectEngine : public SocketEngine { private: - std::map 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 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 int GetMaxFds(); @@ -44,9 +55,13 @@ public: virtual std::string GetName(); }; +/** Creates a SocketEngine + */ class SocketEngineFactory { public: + /** Create a new instance of SocketEngine based on SelectEngine + */ SocketEngine* Create(InspIRCd* Instance) { return new SelectEngine(InspIRCd* Instance); } }; -- cgit v1.3.1-10-gc9f91