Implement support for SQUERY from RFC 2812.

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

diff --git a/include/modules.h b/include/modules.h
index 86b620d0729881e23a8e7bc2faf55d8e083d189f..de418a785777971b74063b16a6aba5875a0a411a 100644 (file)
--- a/include/modules.h
+++ b/include/modules.h
@@ -107,7 +107,7 @@ struct ModResult {
  * and numerical comparisons in preprocessor macros if they wish to support
  * multiple versions of InspIRCd in one file.
  */
-#define INSPIRCD_VERSION_API 1
+#define INSPIRCD_VERSION_API 2
 
 /**
  * This #define allows us to call a method in all
@@ -926,6 +926,12 @@ class CoreExport Module : public classbase, public usecountbase
         */
        virtual void OnServiceDel(ServiceProvider& service);
 
+       /** Called whenever a message is about to be written to a user.
+        * @param user The user who is having a message sent to them.
+        * @param msg The message which is being written to the user.
+        * @return MOD_RES_ALLOW to explicitly allow the message to be sent, MOD_RES_DENY to explicitly
+        * deny the message from being sent, or MOD_RES_PASSTHRU to let another module handle the event.
+        */
        virtual ModResult OnUserWrite(LocalUser* user, ClientProtocol::Message& msg);
 };