Remove the Kiwi links from the readme.

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

diff --git a/include/modules/server.h b/include/modules/server.h
index f9907ef261dbc4935bb1e60a809ad6a593265862..63aa39e4a3e25100a51d355cdf07f72437c8c863 100644 (file)
--- a/include/modules/server.h
+++ b/include/modules/server.h
@@ -1,6 +1,10 @@
 /*
  * InspIRCd -- Internet Relay Chat Daemon
  *
+ *   Copyright (C) 2015 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2013, 2017-2019 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2010 Craig Edwards <brain@inspircd.org>
  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
  *
  * This file is part of InspIRCd.  InspIRCd is free software: you can
@@ -19,13 +23,27 @@
 
 #pragma once
 
+#ifdef __GNUC__
+# pragma GCC diagnostic push
+# pragma GCC diagnostic ignored "-Wdeprecated-declarations"
+#endif
+
 #include "event.h"
 
-class ServerEventListener : public Events::ModuleEventListener
+namespace ServerProtocol
+{
+       class BroadcastEventListener;
+       class LinkEventListener;
+       class MessageEventListener;
+       class SyncEventListener;
+}
+
+class ServerProtocol::BroadcastEventListener
+       : public Events::ModuleEventListener
 {
  public:
-       ServerEventListener(Module* mod)
-               : ModuleEventListener(mod, "event/server")
+       BroadcastEventListener(Module* mod)
+               : ModuleEventListener(mod, "event/server-broadcast")
        {
        }
 
@@ -36,16 +54,71 @@ class ServerEventListener : public Events::ModuleEventListener
         *         send the message to the server or MOD_RES_PASSTHRU if no module handled the event.
         */
        virtual ModResult OnBroadcastMessage(Channel* channel, const Server* server) { return MOD_RES_PASSTHRU; }
+};
+
+class ServerProtocol::LinkEventListener
+       : public Events::ModuleEventListener
+{
+ public:
+       LinkEventListener(Module* mod)
+               : ModuleEventListener(mod, "event/server-link")
+       {
+       }
 
-       /** Fired when a server finishes burst
-        * @param server Server that recently linked and finished burst
+       /** Fired when a server has linked to the network.
+        * @param server Server that recently linked.
         */
        virtual void OnServerLink(const Server* server) { }
 
-        /** Fired when a server splits
-         * @param server Server that split
-         */
-       virtual void OnServerSplit(const Server* server) { }
+       /** Fired when a server has finished bursting.
+        * @param server Server that recently finished bursting.
+        */
+       virtual void OnServerBurst(const Server* server) { }
+
+       /** Fired when a server splits
+        * @param server Server that split
+        * @param error Whether the server split because of an error.
+        */
+       virtual void OnServerSplit(const Server* server, bool error) { OnServerSplit(server); }
+
+       /** Fired when a server splits
+        * @param server Server that split
+        */
+       DEPRECATED_METHOD(virtual void OnServerSplit(const Server* server)) { }
+};
+
+class ServerProtocol::MessageEventListener
+       : public Events::ModuleEventListener
+{
+ public:
+       MessageEventListener(Module* mod)
+               : ModuleEventListener(mod, "event/server-message")
+       {
+       }
+
+       /** Fired when a server message is being sent by a user.
+        * @param source The user who sent the message.
+        * @param name The name of the command which was sent.
+        * @param tags The tags which will be sent with the message.
+        */
+       virtual void OnBuildMessage(User* source, const char* name, ClientProtocol::TagMap& tags) { }
+
+       /** Fired when a server message is being sent by a server.
+        * @param source The server who sent the message.
+        * @param name The name of the command which was sent.
+        * @param tags The tags which will be sent with the message.
+        */
+       virtual void OnBuildMessage(Server* source, const char* name, ClientProtocol::TagMap& tags) { }
+};
+
+class ServerProtocol::SyncEventListener
+       : public Events::ModuleEventListener
+{
+ public:
+       SyncEventListener(Module* mod)
+               : ModuleEventListener(mod, "event/server-sync")
+       {
+       }
 
        /** Allows modules to synchronize user metadata during a netburst. This will
         * be called for every user visible on your side of the burst.
@@ -66,3 +139,23 @@ class ServerEventListener : public Events::ModuleEventListener
         */
        virtual void OnSyncNetwork(ProtocolServer& server) { }
 };
+
+/** Compatibility struct for <3.3.0 modules. */
+class ServerEventListener
+       : public ServerProtocol::BroadcastEventListener
+       , public ServerProtocol::LinkEventListener
+       , public ServerProtocol::SyncEventListener
+{
+ public:
+       ServerEventListener(Module* mod)
+               : ServerProtocol::BroadcastEventListener(mod)
+               , ServerProtocol::LinkEventListener(mod)
+               , ServerProtocol::SyncEventListener(mod)
+       {
+       }
+};
+
+#ifdef __GNUC__
+# pragma GCC diagnostic pop
+#endif
+