X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fxline.h;h=5f1f568fc7bba04e37b430c1085666757c25a219;hb=219d0fa1a64c5c2c155942ebc52543dd956519b1;hp=0aaa21a16f06fa9e6e50783b1fd007b24b28fb6a;hpb=aa692dc1039b63deef7886e914ec499abe7facaf;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/xline.h b/include/xline.h index 0aaa21a16..5f1f568fc 100644 --- a/include/xline.h +++ b/include/xline.h @@ -2,8 +2,8 @@ * InspIRCd -- Internet Relay Chat Daemon * * Copyright (C) 2019 Matt Schatz - * Copyright (C) 2013, 2016 Attila Molnar - * Copyright (C) 2012-2013, 2017-2018 Sadie Powell + * Copyright (C) 2013 Attila Molnar + * Copyright (C) 2012-2013, 2017-2018, 2020 Sadie Powell * Copyright (C) 2012, 2018-2019 Robby * Copyright (C) 2009 Daniel De Graaf * Copyright (C) 2007-2008 Robin Burchell @@ -29,7 +29,7 @@ /** XLine is the base class for ban lines such as G-lines and K-lines. * Modules may derive from this, and their xlines will automatically be * handled as expected by any protocol modules (e.g. m_spanningtree will - * propogate them using AddLine). The process of translating a type+pattern + * propagate them using AddLine). The process of translating a type+pattern * to a known line type is done by means of an XLineFactory object (see * below). */ @@ -128,7 +128,7 @@ class CoreExport XLine : public classbase */ time_t set_time; - /** The duration of the ban, or 0 if permenant + /** The duration of the ban, or 0 if permanent */ unsigned long duration; @@ -435,7 +435,7 @@ class CoreExport XLineManager */ ~XLineManager(); - /** Split an ident and host into two seperate strings. + /** Split an ident and host into two separate strings. * This allows for faster matching. */ IdentHostPair IdentSplit(const std::string &ident_and_host); @@ -529,14 +529,15 @@ class CoreExport XLineManager */ void ApplyLines(); - /** Handle /STATS for a given type. - * NOTE: Any items in the list for this particular line type which have expired - * will be expired and removed before the list is displayed. - * @param type The type of stats to show - * @param numeric The numeric to give to each result line - * @param stats Stats context + /** DEPRECATED: use the `bool InvokeStats(const std::string&, Stats::Context&)` overload instead. */ + DEPRECATED_METHOD(void InvokeStats(const std::string& type, unsigned int numeric, Stats::Context& stats)); + + /** Generates a /STATS response for the given X-line type. + * @param type The type of X-line to look up. + * @param context The stats context to respond with. + * @return True if a response was sent; otherwise, false. */ - void InvokeStats(const std::string& type, unsigned int numeric, Stats::Context& stats); + bool InvokeStats(const std::string& type, Stats::Context& context); /** Expire X-lines which were added by the server configuration and have been removed. */ void ExpireRemovedConfigLines(const std::string& type, const insp::flat_set& configlines);