2
0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-09-01 22:45:18 +00:00

[#1798] Addressed wording comments

This commit is contained in:
Francis Dupont
2021-05-14 14:41:54 +02:00
parent a6845014d0
commit 0cf735721e

View File

@@ -869,22 +869,22 @@ private:
/// ///
/// This method should be called before @ref getIdleConnection. /// This method should be called before @ref getIdleConnection.
/// ///
/// In a first step it closed not usable idle connections /// In a first step it closes not usable idle connections
/// (idle means no current transaction and not closed, /// (idle means no current transaction and not closed,
/// usable means the peer side did not close it at that time). /// usable means the peer side did not close it at that time).
/// In a second step it removes (collects) closed connections. /// In a second step it removes (collects) closed connections.
/// ///
/// @note a connection is closed when the transaction is finished /// @note a connection is closed when the transaction is finished
/// and the connection is persistent, or when the connection was /// and the connection is persistent, or when the connection was
/// idle and the first step of the garbage collector detects was /// idle and the first step of the garbage collector detects that
/// closed by the peer side so is not usable. /// it was closed by peer, so is not usable.
/// ///
/// @note there are two races here: /// @note there are two races here:
/// - the peer side closes the connection after the first step /// - the peer side closes the connection after the first step
/// - a not persistent connection finishes its transaction and /// - a not persistent connection finishes its transaction and
/// closes /// closes
/// The second race is avoided by setting the closed flag before /// The second race is avoided by setting the closed flag before
/// the started flag. And by unconditionally post a process next /// the started flag and by unconditionally posting a process next
/// request action. /// request action.
/// ///
/// @note This should be called in a thread safe context. /// @note This should be called in a thread safe context.