Reduce size of max number of bytes in a bitfield from a 4 or 8 byte field to a 1...

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

diff --git a/include/socketengine.h b/include/socketengine.h
index 1b68f16854289ed5c908626a28c2eea0e575ce1f..9b3cdec646c635b2bc0c57c490587ba055f259bf 100644 (file)
--- a/include/socketengine.h
+++ b/include/socketengine.h
@@ -26,11 +26,15 @@
 /** Types of event an EventHandler may receive.
  * EVENT_READ is a readable file descriptor,
  * and EVENT_WRITE is a writeable file descriptor.
+ * EVENT_ERROR can always occur, and indicates
+ * a write error or read error on the socket,
+ * e.g. EOF condition or broken pipe.
  */
 enum EventType
 {
        EVENT_READ      =       0,
-       EVENT_WRITE     =       1
+       EVENT_WRITE     =       1,
+       EVENT_ERROR     =       2
 };
 
 class InspIRCd;
@@ -93,6 +97,12 @@ class EventHandler : public Extensible
         * is still added to a SocketEngine instance!
         * If this function is unimplemented, the base class
         * will return true.
+        * 
+        * 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
+        * trigger your objects next EVENT_WRITE type event.
         */
        virtual bool Readable();
 
@@ -103,6 +113,12 @@ class EventHandler : public Extensible
         * is still added to a SocketEngine instance!
         * If this function is unimplemented, the base class
         * will return false.
+        *
+         * 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
+        * trigger your objects next EVENT_WRITE type event.
         */
        virtual bool Writeable();
 
@@ -110,11 +126,12 @@ class EventHandler : public Extensible
         * You MUST implement this function in your derived
         * class, and it will be called whenever read or write
         * events are received, depending on what your functions
-        * Readable() and Writeable() returns.
+        * Readable() and Writeable() returns and wether you
+        * previously made a call to SocketEngine::WantWrite().
         * @param et either one of EVENT_READ for read events,
         * and EVENT_WRITE for write events.
         */
-       virtual void HandleEvent(EventType et) = 0;
+       virtual void HandleEvent(EventType et, int errornum = 0) = 0;
 };
 
 /** Provides basic file-descriptor-based I/O support.
@@ -179,6 +196,19 @@ public:
         */
        virtual bool AddFd(EventHandler* eh);
 
+       /** If you call this function and pass it an
+        * event handler, that event handler will
+        * receive the next available write event,
+        * even if the socket is a readable socket only.
+        * Developers should avoid constantly keeping
+        * an eventhandler in the writeable state,
+        * as this will consume large amounts of
+        * CPU time.
+        * @param eh An event handler which wants to
+        * receive the next writeability event.
+        */
+       virtual void WantWrite(EventHandler* eh);
+
        /** Returns the maximum number of file descriptors
         * you may store in the socket engine at any one time.
         * @return The maximum fd value