And another error fix

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

diff --git a/include/socketengine.h b/include/socketengine.h
index 0ff6e89eda5dd20c96d51ed96df600ad81097bea..1124966568387bde492e1a5eb3cf7b5070283dc9 100644 (file)
--- a/include/socketengine.h
+++ b/include/socketengine.h
@@ -29,8 +29,11 @@
  */
 enum EventType
 {
+       /** Read event */
        EVENT_READ      =       0,
+       /** Write event */
        EVENT_WRITE     =       1,
+       /** Error event */
        EVENT_ERROR     =       2
 };
 
@@ -111,7 +114,7 @@ class CoreExport EventHandler : public Extensible
         * If this function is unimplemented, the base class
         * will return false.
         *
-         * NOTE: You cannot set both Readable() and
+        * NOTE: You cannot set both Readable() and
         * Writeable() to true. If you wish to receive
         * a write event for your object, you must call
         * SocketEngine::WantWrite() instead. This will
@@ -139,9 +142,13 @@ class CoreExport EventHandler : public Extensible
        /** Pointer to read event. We delete this so the buffer can't be used
         * after the socket is deleted, and so it doesn't leak memory
         */
-       void * m_readEvent;
-       void * m_writeEvent;
-       void * m_acceptEvent;
+       void* m_readEvent;
+       /** Pointer to a write event.
+        */
+       void* m_writeEvent;
+       /** Pointer to an accept event.
+        */
+       void* m_acceptEvent;
 
 #endif
 };
@@ -283,6 +290,13 @@ public:
         * @return The socket engine name
         */
        virtual std::string GetName();
+
+       /** Returns true if the file descriptors in the
+        * given event handler are within sensible ranges
+        * which can be handled by the socket engine.
+        */
+       bool BoundsCheckFd(EventHandler* eh);
 };
 
 #endif
+