ouch/inspircd
2
0
Fork 0
mirror of https://github.com/inspircd/inspircd.git synced 2025-03-09 18:49:03 -04:00
Code Issues Packages Projects Releases Wiki Activity

Document SendMetaData.

Browse Source 
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@10706 e03df62e-2008-0410-955e-edbf42e46eb7
This commit is contained in:
w00t 2008-10-25 12:59:12 +00:00
parent 2be4fff3e3
commit 8e735c8f3a
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
include/protocol.h
View File

@ -42,7 +42,7 @@ class ProtocolInterface : public Extensible
ProtocolInterface(InspIRCd* Instance) : ServerInstance(Instance) { }
virtual ~ProtocolInterface() { }
/** Generate an ENCAP message.
/** Send an ENCAP message to one or more linked servers.
* 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.
@ -50,6 +50,12 @@ class ProtocolInterface : public Extensible
*/
virtual void SendEncapsulatedData(parameterlist &encap) { }
/** Send metadata for an object to other linked servers.
* @param target The object to send metadata for.
* @param type The type of metadata to send (TYPE_USER, TYPE_CHANNEL, etc)
* @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 SendTopic(Channel* channel, std::string &topic) { }