include/modules/server.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   5  *
   6  * This file is part of InspIRCd.  InspIRCd is free software: you can
   7  * redistribute it and/or modify it under the terms of the GNU General Public
   8  * License as published by the Free Software Foundation, version 2.
   9  *
  10  * This program is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  12  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  13  * details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19
  20 #pragma once
  21
  22 #include "event.h"
  23
  24 class ServerEventListener : public Events::ModuleEventListener
  25 {
  26  public:
  27         ServerEventListener(Module* mod)
  28                 : ModuleEventListener(mod, "event/server")
  29         {
  30         }
  31
  32         /** Fired when a channel message is being broadcast across the network.
  33          * @param channel The channel which is having a message sent to it.
  34          * @param server The server which might have a message broadcast to it.
  35          * @return Either MOD_RES_ALLOW to always send the message to the server, MOD_RES_DENY to never
  36          *         send the message to the server or MOD_RES_PASSTHRU if no module handled the event.
  37          */
  38         virtual ModResult OnBroadcastMessage(Channel* channel, const Server* server) { return MOD_RES_PASSTHRU; }
  39
  40         /** Fired when a server finishes burst
  41          * @param server Server that recently linked and finished burst
  42          */
  43         virtual void OnServerLink(const Server* server) { }
  44
  45          /** Fired when a server splits
  46           * @param server Server that split
  47           */
  48         virtual void OnServerSplit(const Server* server) { }
  49
  50         /** Allows modules to synchronize user metadata during a netburst. This will
  51          * be called for every user visible on your side of the burst.
  52          * @param user The user being synchronized.
  53          * @param server The target of the burst.
  54          */
  55         virtual void OnSyncUser(User* user, ProtocolServer& server) { }
  56
  57         /** Allows modules to synchronize channel metadata during a netburst. This will
  58          * be called for every channel visible on your side of the burst.
  59          * @param chan The channel being synchronized.
  60          * @param server The target of the burst.
  61          */
  62         virtual void OnSyncChannel(Channel* chan, ProtocolServer& server) { }
  63
  64         /** Allows modules to synchronize network metadata during a netburst.
  65          * @param server The target of the burst.
  66          */
  67         virtual void OnSyncNetwork(ProtocolServer& server) { }
  68
  69 };