X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fisupportmanager.h;h=e5eeb599e7767d450103f777ef019bff551ef835;hb=79892a727e323dcc4bce7e9c0cf3c99c5fe61706;hp=3915b8b1b580961a1aac311e6fb0e648b47d291c;hpb=e7bdcd71dce911f64d8f0c85f4935dfa83a81dd3;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/isupportmanager.h b/include/isupportmanager.h index 3915b8b1b..e5eeb599e 100644 --- a/include/isupportmanager.h +++ b/include/isupportmanager.h @@ -24,15 +24,28 @@ class CoreExport ISupportManager { private: /** The generated lines which are sent to clients. */ - std::vector cachedlines; + std::vector cachedlines; + + /** Escapes an ISUPPORT token value and appends it to the buffer. + * @param buffer The buffer to append to. + * @param value An ISUPPORT token value. + */ + void AppendValue(std::string& buffer, const std::string& value); public: - /** (Re)build the ISUPPORT vector. */ + /** (Re)build the ISUPPORT vector. + * Called by the core on boot after all modules have been loaded, and every time when a module is loaded + * or unloaded. Calls the On005Numeric hook, letting modules manipulate the ISUPPORT tokens. + */ void Build(); - /** Returns the std::vector of ISUPPORT lines. */ - const std::vector& GetLines() const { return cachedlines; } + /** Returns the cached std::vector of ISUPPORT lines. + * @return A list of Numeric::Numeric objects prepared for sending to users + */ + const std::vector& GetLines() const { return cachedlines; } - /** Send the 005 numerics (ISUPPORT) to a user. */ + /** Send the 005 numerics (ISUPPORT) to a user. + * @param user The user to send the ISUPPORT numerics to + */ void SendTo(LocalUser* user); };