summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorPeter Powell <petpow@saberuk.com>2019-09-02 15:17:30 +0100
committerPeter Powell <petpow@saberuk.com>2019-09-02 15:17:30 +0100
commit5cf6f65044c27a69e70d795d75e826ce3f0b97a1 (patch)
tree40247603a5556705a8638f9124fc48f481d943e6 /include
parent78f9c572119aef08c9115ad61caa41e82b41c98a (diff)
Document ConfigStatus and add a way to detect the initial load.
Diffstat (limited to 'include')
-rw-r--r--include/configreader.h14
1 files changed, 12 insertions, 2 deletions
diff --git a/include/configreader.h b/include/configreader.h
index 511bedbee..a891f98f7 100644
--- a/include/configreader.h
+++ b/include/configreader.h
@@ -490,13 +490,23 @@ class CoreExport ConfigReaderThread : public Thread
bool IsDone() { return done; }
};
+/** Represents the status of a config load. */
class CoreExport ConfigStatus
{
public:
+ /** Whether this is the initial config load. */
+ bool const initial;
+
+ /** The user who initiated the config load or NULL if not initiated by a user. */
User* const srcuser;
- ConfigStatus(User* user = NULL)
- : srcuser(user)
+ /** Initializes a new instance of the ConfigStatus class.
+ * @param user The user who initiated the config load or NULL if not initiated by a user.
+ * @param isinitial Whether this is the initial config load.
+ */
+ ConfigStatus(User* user = NULL, bool isinitial = false)
+ : initial(isinitial)
+ , srcuser(user)
{
}
};