Access local user list via new UserManager::GetLocalUsers() and make local_users...

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

diff --git a/include/protocol.h b/include/protocol.h
index 4afb0bf59165cb86890330bdaa1edf62db543c8c..01eb145f176200914e364ed9b5d14f4b9e45a96b 100644 (file)
--- a/include/protocol.h
+++ b/include/protocol.h
@@ -56,14 +56,27 @@ class CoreExport 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 a channel to other linked servers.
         * @param chan The channel to send metadata for