summaryrefslogtreecommitdiffstats
path: root/src/lib/stats/stats.dox
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/stats/stats.dox')
-rw-r--r--src/lib/stats/stats.dox16
1 files changed, 16 insertions, 0 deletions
diff --git a/src/lib/stats/stats.dox b/src/lib/stats/stats.dox
new file mode 100644
index 0000000..7d4d3b5
--- /dev/null
+++ b/src/lib/stats/stats.dox
@@ -0,0 +1,16 @@
+// Copyright (C) 2020 Internet Systems Consortium, Inc. ("ISC")
+//
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+/**
+ @page libstats libkea-stats - Kea Statistics Library
+
+@section statsMTConsiderations Multi-Threading Consideration for Statistics
+
+The statistic manager (@c isc::stats::StatsMgr singleton) is Kea thread safe
+i.e. it is thread safe when the multi-threading mode is true (when the
+multi-threading mode is false Kea main thread processes packets).
+
+*/