X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fprotocol.h;h=9634ee4ec77cfda3eb9d0b9a72ab73ece38d25e6;hb=ffc039651676e0f679726b15fac4bf133e7e5bc2;hp=8579f03aacdfc74beafd669911912403ef194bfa;hpb=e078fae142238765f279b50c309f22a5a0761ce4;p=user%2Fhenk%2Fcode%2Finspircd.git

diff --git a/include/protocol.h b/include/protocol.h
index 8579f03aa..9634ee4ec 100644
--- a/include/protocol.h
+++ b/include/protocol.h
@@ -42,17 +42,38 @@ class ProtocolInterface : public Extensible
 	ProtocolInterface(InspIRCd* Instance) : ServerInstance(Instance) { }
 	virtual ~ProtocolInterface() { }
 
+	/** 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.
+	 * ENCAP (should) be used instead of creating new protocol messages for easier third party application support.
+	 */
 	virtual void SendEncapsulatedData(parameterlist &encap) { }
 
-	virtual void SendMetaData(void* target, int type, const std::string &key, const std::string &data) { }
-
+	/** 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, 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.
+	 * @param topic The new topic to use for the channel.
+	 */
 	virtual void SendTopic(Channel* channel, std::string &topic) { }
 
+	/** Send mode changes for an object.
+	 * @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) { }
 
+	/** Convenience function, string wrapper around the above.
+	  */
 	virtual void SendModeStr(const std::string &target, const std::string &modeline)
 	{
-		/* Convenience function */
 		irc::spacesepstream x(modeline);
 		parameterlist n;
 		std::string v;
@@ -61,22 +82,59 @@ class ProtocolInterface : public Extensible
 		SendMode(target, n);
 	}
 
+	/** 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) { }
 };