Feature request outlined in bug #257, allow connect/allow lines by port

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

diff --git a/include/socketengine.h b/include/socketengine.h
index 9b3cdec646c635b2bc0c57c490587ba055f259bf..729f5e0909a8fb66275857bb28cd5bd1c8f8fb57 100644 (file)
--- a/include/socketengine.h
+++ b/include/socketengine.h
@@ -2,17 +2,14 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
- *                       E-mail:
- *                <brain@chatspike.net>
- *                <Craig@chatspike.net>
+ *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/Credits
  *
- * Written by Craig Edwards, Craig McLure, and others.
  * This program is free but copyrighted software; see
  *            the file COPYING for details.
  *
  * ---------------------------------------------------
-*/
+ */
 
 #ifndef __SOCKETENGINE__
 #define __SOCKETENGINE__
@@ -97,7 +94,7 @@ 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
@@ -227,10 +224,18 @@ public:
         * and false if it failed. This does not free the
         * EventHandler pointer using delete, if this is
         * required you must do this yourself.
+        * Note on forcing deletes. DO NOT DO THIS! This is
+        * extremely dangerous and will most likely render the
+        * socketengine dead. This was added only for handling
+        * very rare cases where broken 3rd party libs destroys
+        * the OS socket beyond our control. If you can't explain
+        * in minute details why forcing is absolutely necessary
+        * then you don't need it. That was a NO!
         * @param eh The event handler object to remove
+        * @param force *DANGEROUS* See method description!
         * @return True if the event handler was removed
         */
-       virtual bool DelFd(EventHandler* eh);
+       virtual bool DelFd(EventHandler* eh, bool force = false);
 
        /** Returns true if a file descriptor exists in
         * the socket engine's list.