Commit 08453120 authored by Francis Dupont's avatar Francis Dupont
Browse files

[#996] Addressed comments

parent e183d8b7
......@@ -49,7 +49,7 @@ The asiolink library (libkea-asiolink) encapsulates Boost ASIO tools:
@section asiolinkMTConsiderations Multi-Threading Consideration for Boost ASIO Utilities
By default Boost ASIO utilities are not thread safe even Boost ASIO tools
By default Boost ASIO utilities are not thread safe even if Boost ASIO tools
themselves are. When there is no state and the encapsulation is direct
the thread safety property is preserved. Exceptions to the by default
no thread safe are:
......
......@@ -9,7 +9,7 @@
@section databaseMTConsiderations Multi-Threading Consideration for Database
MySQL and PostgreSQL provide connection pools which is used to make
MySQL and PostgreSQL provide connection pools which are used to make
lease, host and legal log backends thread safe. Cassandra/CQL is
thread safe by design.
......@@ -19,7 +19,7 @@ a transaction). For MySQL this means that transactions must be supported
by the database engine (the engine selection is done in the schema).
Note the InnoDB engine used by Kea for MySQL databases cancels a transaction
when a deadlock is detected (rare but possible event) and leaves the charge
to retry the transaction to the caller.
when a deadlock is detected (rare but possible event) and leaves the
responsibility to retry the transaction to the caller.
*/
......@@ -201,10 +201,11 @@
@section dhcpDatabaseBackendsMTConsiderations Multi-Threading Consideration for DHCP Database Backends
Lease and host database backends including the memfile for leases are Kea
(i.e. when the multi-threading mode is true) thread safe. This extends
to legal / forensic log backends but not to config backends which is
used only for configuration by the main thread with packet processing
threads stopped so has no thread safety requirements.
thread safe (i.e. are thread safe when the multi-threading mode is true).
This extends to legal / forensic log backends but not to config
backends which is used only for configuration by the main thread with
packet processing threads stopped so has no thread safety
requirements.
There are exceptions:
......@@ -219,7 +220,7 @@ There are exceptions:
Note for statistics queries it does not make sense to call them with
running packet processing threads so they have no thread safety guarantees.
Note too the memfile backend is not inter-process safe so must be kept
Note too that the memfile backend is not inter-process safe so must be kept
private to the Kea server using it.
*/
......@@ -12,8 +12,8 @@
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 (i.e. when the multi-threading mode is treu)
thread safe.
- 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
......
......@@ -50,12 +50,12 @@ The utilities library (libkea-util) provides generic and Kea utilities:
- read-write mutex (header only).
- signal set: signal handling (please @c isc::process::IOSignalSet instead).
- signal set: signal handling (please use @c isc::process::IOSignalSet
instead).
- staged values.
- state model: event-driven deterministic finite state automaton
(to accept a regular language).
- state model: event-driven deterministic finite state machine.
- stop watch: to measure code execution time.
......
K// Copyright (C) 2018-2020 Internet Systems Consortium, Inc. ("ISC")
// Copyright (C) 2018-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
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment