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 server finishes burst
  33          * @param server Server that recently linked and finished burst
  34          */
  35         virtual void OnServerLink(const Server* server) { }
  36
  37          /** Fired when a server splits
  38           * @param server Server that split
  39           */
  40         virtual void OnServerSplit(const Server* server) { }
  41
  42         /** Allows modules to synchronize user metadata during a netburst. This will
  43          * be called for every user visible on your side of the burst.
  44          * @param user The user being synchronized.
  45          * @param server The target of the burst.
  46          */
  47         virtual void OnSyncUser(User* user, ProtocolServer& server) { }
  48
  49         /** Allows modules to synchronize channel metadata during a netburst. This will
  50          * be called for every channel visible on your side of the burst.
  51          * @param chan The channel being synchronized.
  52          * @param server The target of the burst.
  53          */
  54         virtual void OnSyncChannel(Channel* chan, ProtocolServer& server) { }
  55
  56         /** Allows modules to synchronize network metadata during a netburst.
  57          * @param server The target of the burst.
  58          */
  59         virtual void OnSyncNetwork(ProtocolServer& server) { }
  60
  61 };