X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;ds=sidebyside;f=include%2Fprotocol.h;h=f98f6b37d4d40a90e344471f9ae0854eacd0eec0;hb=87b1461e2a4710a38b32186c2582da9fe9bb3804;hp=4c58c78ba379ca5c0ea9e8aaf79237a02e3b01e2;hpb=92cc388aebd55245b24aef5950afe845feffe9e2;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/protocol.h b/include/protocol.h index 4c58c78ba..f98f6b37d 100644 --- a/include/protocol.h +++ b/include/protocol.h @@ -24,8 +24,6 @@ class User; -typedef std::vector parameterlist; - class ProtocolServer { public: @@ -46,7 +44,7 @@ class CoreExport ProtocolInterface public: std::string servername; std::string parentname; - std::string gecos; + std::string description; unsigned int usercount; unsigned int opercount; unsigned int latencyms; @@ -66,7 +64,17 @@ class CoreExport ProtocolInterface * 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. */ - virtual bool SendEncapsulatedData(const std::string& targetmask, const std::string& cmd, const parameterlist& params, User* source = NULL) { return false; } + virtual bool SendEncapsulatedData(const std::string& targetmask, const std::string& cmd, const CommandBase::Params& 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 CommandBase::Params& params, User* source = NULL, User* omit = NULL) { } /** Send metadata for a channel to other linked servers. * @param chan The channel to send metadata for @@ -88,36 +96,15 @@ class CoreExport ProtocolInterface */ 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. - * @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 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 SendMode(User* source, User* usertarget, Channel* chantarget, const parameterlist& modedata, const std::vector& translate) { } - /** 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(char 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 status The status character (e.g. %) required to receive. * @param text The message to send. * @param type The message type (MSG_PRIVMSG or MSG_NOTICE) */ @@ -132,7 +119,7 @@ class CoreExport ProtocolInterface /** Send a notice to a channel. * @param target The channel to message. - * @param status The status character (e.g. %) required to recieve. + * @param status The status character (e.g. %) required to receive. * @param text The message to send. */ void SendChannelNotice(Channel* target, char status, const std::string &text)