include/protocol.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
   6  * See: http://www.inspircd.org/wiki/index.php/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *            the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #ifndef __PROTOCOL_H__
  15 #define __PROTOCOL_H__
  16
  17 #include "hashcomp.h"
  18
  19 class InspIRCd;
  20 class User;
  21
  22 typedef std::deque<std::string> parameterlist;
  23
  24 class ProtoServer
  25 {
  26  public:
  27         std::string servername;
  28         std::string parentname;
  29         unsigned int usercount;
  30         unsigned int opercount;
  31         unsigned int latencyms;
  32 };
  33
  34 typedef std::list<ProtoServer> ProtoServerList;
  35
  36 class ProtocolInterface : public Extensible
  37 {
  38  protected:
  39         InspIRCd* ServerInstance;
  40  public:
  41         ProtocolInterface(InspIRCd* Instance) : ServerInstance(Instance) { }
  42         virtual ~ProtocolInterface() { }
  43
  44         virtual void SendEncapsulatedData(parameterlist &encap) { }
  45
  46         virtual void SendMetaData(void* target, int type, const std::string &key, const std::string &data) { }
  47
  48         virtual void SendTopic(Channel* channel, std::string &topic) { }
  49
  50         virtual void SendMode(const std::string &target, parameterlist &modedata) { }
  51
  52         virtual void SendModeStr(const std::string &target, const std::string &modeline)
  53         {
  54                 /* Convenience function */
  55                 irc::spacesepstream x(modeline);
  56                 parameterlist n;
  57                 std::string v;
  58                 while (x.GetToken(v))
  59                         n.push_back(v);
  60                 SendMode(target, n);
  61         }
  62
  63         virtual void SendModeNotice(const std::string &modes, const std::string &text) { }
  64
  65         virtual void SendSNONotice(const std::string &snomask, const std::string &text) { }
  66
  67         virtual void PushToClient(User* target, const std::string &rawline) { }
  68
  69         virtual void SendChannelPrivmsg(Channel* target, char status, const std::string &text) { }
  70
  71         virtual void SendChannelNotice(Channel* target, char status, const std::string &text) { }
  72
  73         virtual void SendUserPrivmsg(User* target, const std::string &text) { }
  74
  75         virtual void SendUserNotice(User* target, const std::string &text) { }
  76
  77         virtual void GetServerList(ProtoServerList &sl) { }
  78
  79         virtual void Introduce(User* u) { }
  80 };
  81
  82 #endif
  83