summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMarcin Siodelski <marcin@isc.org>2023-01-16 23:03:45 +0100
committerMarcin Siodelski <marcin@isc.org>2023-01-17 11:28:35 +0100
commitca7a432c1995a4e637e56b270ac3029e3a3418bf (patch)
treeeea0b04a19c9cbed477e7c5976632b5e22bf6fe6 /doc
parent[#2688] Add timeout units to example files (diff)
downloadkea-ca7a432c1995a4e637e56b270ac3029e3a3418bf.tar.xz
kea-ca7a432c1995a4e637e56b270ac3029e3a3418bf.zip
[#2688] Added a note into the ARM
It says that the timeouts are only effective for TCP connections.
Diffstat (limited to 'doc')
-rw-r--r--doc/sphinx/arm/dhcp4-srv.rst8
-rw-r--r--doc/sphinx/arm/dhcp6-srv.rst8
2 files changed, 16 insertions, 0 deletions
diff --git a/doc/sphinx/arm/dhcp4-srv.rst b/doc/sphinx/arm/dhcp4-srv.rst
index ad94851cf2..ab229969de 100644
--- a/doc/sphinx/arm/dhcp4-srv.rst
+++ b/doc/sphinx/arm/dhcp4-srv.rst
@@ -590,6 +590,14 @@ in seconds. For example:
Specifying this parameter for other backend types causes a configuration
error.
+.. note::
+
+ The timeouts described here are only effective for TCP connections.
+ Please note that the MySQL client library used by the Kea servers
+ typically connects to the database via a UNIX domain socket when the
+ ``host`` parameter is ``localhost`` but establishes a TCP connection
+ for ``127.0.0.1``.
+
.. _hosts4-storage:
diff --git a/doc/sphinx/arm/dhcp6-srv.rst b/doc/sphinx/arm/dhcp6-srv.rst
index 2823fc3ff5..68c6123d7b 100644
--- a/doc/sphinx/arm/dhcp6-srv.rst
+++ b/doc/sphinx/arm/dhcp6-srv.rst
@@ -547,6 +547,14 @@ in seconds. For example:
Specifying this parameter for other backend types causes a configuration
error.
+.. note::
+
+ The timeouts described here are only effective for TCP connections.
+ Please note that the MySQL client library used by the Kea servers
+ typically connects to the database via a UNIX domain socket when the
+ ``host`` parameter is ``localhost`` but establishes a TCP connection
+ for ``127.0.0.1``.
+
.. _hosts6-storage: