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
  21 typedef std::deque<std::string> parameterlist;
  22
  23 class ProtocolInterface : public Extensible
  24 {
  25  protected:
  26         InspIRCd* ServerInstance;
  27  public:
  28         ProtocolInterface(InspIRCd* Instance) : ServerInstance(Instance) { }
  29         virtual ~ProtocolInterface() { }
  30
  31         virtual void SendEncapsulatedData(parameterlist &encap) { }
  32
  33         virtual void SendMetaData(void* target, int type, const std::string &key, const std::string &data) { }
  34
  35         virtual void SendTopic(Channel* channel, std::string &topic) { }
  36
  37         virtual void SendMode(const std::string &target, parameterlist &modedata) { }
  38
  39         virtual void SendModeStr(const std::string &target, const std::string &modeline)
  40         {
  41                 /* Convenience function */
  42                 irc::spacesepstream x(modeline);
  43                 parameterlist n;
  44                 std::string v;
  45                 while (x.GetToken(v))
  46                         n.push_back(v);
  47                 SendMode(target, n);
  48         }
  49
  50         virtual void SendOperNotice(const std::string &text) { }
  51
  52         virtual void SendModeNotice(const std::string &modes, const std::string &text) { }
  53
  54         virtual void SendSNONotice(const std::string &snomask, const std::string &text) { }
  55
  56         virtual void PushToClient(User* target, const std::string &rawline) { }
  57 };
  58
  59 #endif
  60