Adding upstream version 2.4.1.upstream/2.4.1upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 24 insertions, 0 deletions

diff --git a/src/lib/http/http.dox b/src/lib/http/http.dox
new file mode 100644
index 0000000..c6e4933
--- /dev/null
+++ b/src/lib/http/http.dox
@@ -0,0 +1,24 @@
+// 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 libhttp libkea-http - Kea HTTP Library
+
+@section httpMTConsiderations Multi-Threading Consideration for HTTP Library
+
+By default this library is not thread safe, for instance HTTP listeners
+and HTTP messages are not thread safe. Exceptions are:
+
+ - HTTP client is Kea thread safe (i.e. is thread safe when the
+  multi-threading mode is true).
+
+ - date time is thread safe (mainly because its encapsulated POSIX time
+  is private and read-only, or because all methods are instance const methods
+  or class methods).
+
+ - URL is thread safe (all public methods are const methods).
+
+*/