X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fprotocol.h;h=2e512f11ae5a6f5906068eeff34405bebb2a0571;hb=c6a508a3da977041909f18f77d6e8fea942512cf;hp=4afb0bf59165cb86890330bdaa1edf62db543c8c;hpb=e244cb2c63b1ac1d85bdbb4691f7b1bd940ae804;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/protocol.h b/include/protocol.h index 4afb0bf59..2e512f11a 100644 --- 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 @@ -85,33 +98,12 @@ 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.