Purely a documentation fix: PRIO_AFTER doesn't exist any more, it's PRIORITY_AFTER.

[user/henk/code/inspircd.git] / include / protocol.h

diff --git a/include/protocol.h b/include/protocol.h
index b6568e313aa17e98d96c3f6b10b32af8eada4208..60fcf4df283e45ce55c384b03b7cd0af7e653f36 100644 (file)
--- a/include/protocol.h
+++ b/include/protocol.h
@@ -2,8 +2,8 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ * See: http://wiki.inspircd.org/Credits
  *
  * This program is free but copyrighted software; see
  *            the file COPYING for details.
@@ -56,7 +56,7 @@ class ProtocolInterface : public Extensible
         * @param key The 'key' of the data, e.g. "swhois" for swhois desc on a user
         * @param data The string representation of the data
         */
-       virtual void SendMetaData(void* target, int type, const std::string &key, const std::string &data) { }
+       virtual void SendMetaData(void* target, TargetTypeFlags type, const std::string &key, const std::string &data) { }
 
        /** Send a topic change for a channel
         * @param channel The channel to change the topic for.
@@ -68,7 +68,7 @@ class ProtocolInterface : public Extensible
         * @param target The channel name or user to send mode changes for.
         * @param The mode changes to send.
         */
-       virtual void SendMode(const std::string &target, parameterlist &modedata) { }
+       virtual void SendMode(const std::string &target, const parameterlist &modedata, const std::deque<TranslateType> &translate) { }
 
        /** Convenience function, string wrapper around the above.
          */
@@ -76,28 +76,69 @@ class ProtocolInterface : public Extensible
        {
                irc::spacesepstream x(modeline);
                parameterlist n;
+               std::deque<TranslateType> types;
                std::string v;
                while (x.GetToken(v))
+               {
                        n.push_back(v);
-               SendMode(target, n);
+                       types.push_back(TR_TEXT);
+               }
+               SendMode(target, n, types);
        }
 
+       /** Send a notice to users with a given mode(s).
+        * @param modes The modes required for the message to be sent.
+        * @param text The message to send.
+        */
        virtual void SendModeNotice(const std::string &modes, const std::string &text) { }
 
+       /** Send a notice to users with a given snomask.
+        * @param snomask The snomask required for the message to be sent.
+        * @param text The message to send.
+        */
        virtual void SendSNONotice(const std::string &snomask, const std::string &text) { }
 
+       /** Send raw data to a remote client.
+        * @param target The user to push data to.
+        * @param rawline The raw IRC protocol line to deliver (":me NOTICE you :foo", whatever).
+        */
        virtual void PushToClient(User* target, const std::string &rawline) { }
 
+       /** Send a message to a channel.
+        * @param target The channel to message.
+        * @param status The status character (e.g. %) required to recieve.
+        * @param text The message to send.
+        */
        virtual void SendChannelPrivmsg(Channel* target, char status, const std::string &text) { }
 
+       /** Send a notice to a channel.
+        * @param target The channel to message.
+        * @param status The status character (e.g. %) required to recieve.
+        * @param text The message to send.
+        */
        virtual void SendChannelNotice(Channel* target, char status, const std::string &text) { }
 
+       /** Send a message to a user.
+        * @param target The user to message.
+        * @param text The message to send.
+        */
        virtual void SendUserPrivmsg(User* target, const std::string &text) { }
 
+       /** Send a notice to a user.
+        * @param target The user to message.
+        * @param text The message to send.
+        */
        virtual void SendUserNotice(User* target, const std::string &text) { }
 
+       /** Fill a list of servers and information about them.
+        * @param sl The list of servers to fill.
+        * XXX: document me properly, this is shit.
+        */
        virtual void GetServerList(ProtoServerList &sl) { }
 
+       /** Send information about a user connection to linked servers.
+        * @param u The user to send information about.
+        */
        virtual void Introduce(User* u) { }
 };