X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fprotocol.h;h=01eb145f176200914e364ed9b5d14f4b9e45a96b;hb=f62654a6859998f9d63eb22702c572d5ebcff15c;hp=6af0ed21c65891e814008bc8c2cbde178f136d36;hpb=1031f333332cf1b09db4fd632f141143ee637c34;p=user%2Fhenk%2Fcode%2Finspircd.git

diff --git a/include/protocol.h b/include/protocol.h
index 6af0ed21c..01eb145f1 100644
--- 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,21 +56,47 @@ 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 metadata for an object to other linked servers.
-	 * @param target The object to send metadata for.
+	/** 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
+	 * @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(Channel* chan, const std::string& key, const std::string& data) { }
+
+	/** 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 SendMetaData(Extensible* target, const std::string &key, const std::string &data) { }
+	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 SendMetaData(const std::string& key, const std::string& data) { }
 
 	/** Send a topic change for a channel
 	 * @param channel The channel to change the topic for.
@@ -79,7 +117,7 @@ class ProtocolInterface
 	 * @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) { }
+	virtual void SendSNONotice(char snomask, const std::string& text) { }
 
 	/** Send raw data to a remote client.
 	 * @param target The user to push data to.