summaryrefslogtreecommitdiffstats
path: root/src/lib/d2srv/d2srv.dox
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/d2srv/d2srv.dox')
-rw-r--r--src/lib/d2srv/d2srv.dox21
1 files changed, 21 insertions, 0 deletions
diff --git a/src/lib/d2srv/d2srv.dox b/src/lib/d2srv/d2srv.dox
new file mode 100644
index 0000000..71d88d5
--- /dev/null
+++ b/src/lib/d2srv/d2srv.dox
@@ -0,0 +1,21 @@
+// Copyright (C) 2020-2022 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 libd2srv libkea-d2srv - Kea D2 Server Library
+
+This library contains most of the DNS classes used by the Kea D2 server
+(kea-dhcp-ddns) but is organized as an independent library so that it
+can be reused as needed by other components.
+
+For a more detailed documentation about the design and class separation
+see @ref src/bin/d2/d2.dox.
+
+@section d2srvMTConsiderations Multi-Threading Consideration for D2 Server Library
+
+By default this library is not thread safe.
+
+*/