DO NOT USE THIS COMMIT - if you do, most of the modules wont work.

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

diff --git a/include/socketengine.h b/include/socketengine.h
index 557c314c6cc39520cbefdf0e2cefc0207079a19c..729f5e0909a8fb66275857bb28cd5bd1c8f8fb57 100644 (file)
--- a/include/socketengine.h
+++ b/include/socketengine.h
@@ -224,7 +224,15 @@ 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, bool force = false);