Merge the latest changes from insp20 into master.

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

diff --git a/include/protocol.h b/include/protocol.h
index 6af0ed21c65891e814008bc8c2cbde178f136d36..2e512f11ae5a6f5906068eeff34405bebb2a0571 100644 (file)
--- a/include/protocol.h
+++ b/include/protocol.h
@@ -26,9 +26,21 @@ class User;
 
 typedef std::vector<std::string> parameterlist;
 
-class ProtocolInterface
+class ProtocolServer
 {
  public:
+       /** Send metadata related to this server to the target server
+        * @param key The 'key' of the data
+        * @param data The string representation of the data
+        */
+       virtual void SendMetaData(const std::string& key, const std::string& data) = 0;
+};
+
+class CoreExport ProtocolInterface
+{
+ public:
+       typedef ProtocolServer Server;
+
        class ServerInfo
        {
         public:
@@ -44,48 +56,53 @@ class ProtocolInterface
 
        virtual ~ProtocolInterface() { }
 
-       /** Send an ENCAP message to one or more linked servers.
+       /** Send an ENCAP message to all servers matching a wildcard string.
         * See the protocol documentation for the purpose of ENCAP.
-        * @param encap This is a list of string parameters, the first of which must be a server ID or glob matching servernames.
-        * The second must be a subcommand. All subsequent parameters are dependant on the subcommand.
+        * @param targetmask The target server mask (can contain wildcards)
+        * @param cmd The ENCAP subcommand
+        * @param params List of string parameters which are dependant on the subcommand
+        * @param source The source of the message (prefix), must be a local user or NULL which means use local server
+        * @return Always true if the target mask contains wildcards; otherwise true if the server name was found,
+        * and the message was sent, false if it was not found.
         * ENCAP (should) be used instead of creating new protocol messages for easier third party application support.
-        * @return True if the message was sent out (target exists)
         */
-       virtual bool SendEncapsulatedData(const parameterlist &encap) { return false; }
+       virtual bool SendEncapsulatedData(const std::string& targetmask, const std::string& cmd, const parameterlist& params, User* source = NULL) { return false; }
+
+       /** Send an ENCAP message to all servers.
+        * See the protocol documentation for the purpose of ENCAP.
+        * @param cmd The ENCAP subcommand
+        * @param params List of string parameters which are dependant on the subcommand
+        * @param source The source of the message (prefix), must be a local user or a user behind 'omit'
+        * or NULL which is equivalent to the local server
+        * @param omit If non-NULL the message won't be sent in the direction of this server, useful for forwarding messages
+        */
+       virtual void BroadcastEncap(const std::string& cmd, const parameterlist& params, User* source = NULL, User* omit = NULL) { }
 
-       /** Send metadata for an object to other linked servers.
-        * @param target The object to send metadata for.
+       /** Send metadata for a channel to other linked servers.
+        * @param chan The channel to send metadata for
         * @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(Extensible* target, const std::string &key, const std::string &data) { }
+       virtual void SendMetaData(Channel* chan, const std::string& key, const std::string& data) { }
 
-       /** Send a topic change for a channel
-        * @param channel The channel to change the topic for.
-        * @param topic The new topic to use for the channel.
+       /** Send metadata for a user to other linked servers.
+        * @param user The user to send metadata for
+        * @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 SendTopic(Channel* channel, std::string &topic) { }
-
-       /** Send mode changes for an object.
-        * @param source The source of the mode change
-        * @param usertarget The target user, NULL if the target is a channel
-        * @param chantarget The target channel, NULL if the target is a user
-        * @param modedata The mode changes to send.
-        * @param translate A list of translation types
+       virtual void SendMetaData(User* user, const std::string& key, const std::string& data) { }
+
+       /** Send metadata related to the server to other linked servers.
+        * @param key The 'key' of the data
+        * @param data The string representation of the data
         */
-       virtual void SendMode(User* source, User* usertarget, Channel* chantarget, const parameterlist& modedata, const std::vector<TranslateType>& translate) { }
+       virtual void SendMetaData(const std::string& key, const std::string& data) { }
 
        /** 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) { }
+       virtual void SendSNONotice(char snomask, const std::string& text) { }
 
        /** Send a message to a channel.
         * @param target The channel to message.