From: Francis Dupont <fdupont@isc.org>
Date: Mon, 22 May 2023 21:11:02 +0000 (+0200)
Subject: [#2757] Added function comments as required from review
X-Git-Tag: Kea-2.3.8~99
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=fa2b7d531828929f4ad8194bbf78bf713ad0e8fb;p=thirdparty%2Fkea.git

[#2757] Added function comments as required from review
---

diff --git a/src/lib/dhcpsrv/lease_mgr.h b/src/lib/dhcpsrv/lease_mgr.h
index fe42783cf9..dca8b93f89 100644
--- a/src/lib/dhcpsrv/lease_mgr.h
+++ b/src/lib/dhcpsrv/lease_mgr.h
@@ -962,6 +962,14 @@ public:
 
     /// @brief Upgrade extended info (v4).
     ///
+    /// On SQL backends for all leases with a not null user context.
+    ///  - sanitize the user context
+    ///  - update relay and remote ids
+    ///  - when the lease was modified update it in the database
+    /// On memfile backend a similar action is done when the database is
+    /// loaded from the file. This function implements the new BLQ hook
+    /// command named "extended-info4-upgrade".
+    ///
     /// @param page_size The page size used for retrieval.
     /// @return The number of updates in the database.
     virtual size_t upgradeExtendedInfo(const LeasePageSize& page_size) = 0;
diff --git a/src/lib/dhcpsrv/memfile_lease_mgr.h b/src/lib/dhcpsrv/memfile_lease_mgr.h
index 15c06f0314..e5831ecc06 100644
--- a/src/lib/dhcpsrv/memfile_lease_mgr.h
+++ b/src/lib/dhcpsrv/memfile_lease_mgr.h
@@ -1511,7 +1511,7 @@ public:
     /// @brief Upgrade extended info (v4).
     ///
     /// @param page_size The page size used for retrieval.
-    /// @return Always return 0.
+    /// @return Always return 0 as this function is a noop for not SQL backends.
     virtual size_t upgradeExtendedInfo(const LeasePageSize& page_size) override;
 
 protected:
diff --git a/src/lib/dhcpsrv/mysql_lease_mgr.h b/src/lib/dhcpsrv/mysql_lease_mgr.h
index ba9f677368..e4be9b5cb5 100644
--- a/src/lib/dhcpsrv/mysql_lease_mgr.h
+++ b/src/lib/dhcpsrv/mysql_lease_mgr.h
@@ -1123,6 +1123,13 @@ private:
 
     /// @brief Upgrade extended info (v4).
     ///
+    /// For all leases with a not null user context.
+    ///  - sanitize the user context
+    ///  - update relay and remote ids
+    ///  - when the lease was modified update it in the database
+    /// This function implements the new BLQ hook command named
+    /// "extended-info4-upgrade".
+    ///
     /// @param page_size The page size used for retrieval.
     /// @return The number of updates in the database.
     virtual size_t upgradeExtendedInfo(const LeasePageSize& page_size) override;
diff --git a/src/lib/dhcpsrv/pgsql_lease_mgr.h b/src/lib/dhcpsrv/pgsql_lease_mgr.h
index 794555abaa..e0534e22e0 100644
--- a/src/lib/dhcpsrv/pgsql_lease_mgr.h
+++ b/src/lib/dhcpsrv/pgsql_lease_mgr.h
@@ -1077,6 +1077,13 @@ private:
 
     /// @brief Upgrade extended info (v4).
     ///
+    /// For all leases with a not null user context.
+    ///  - sanitize the user context
+    ///  - update relay and remote ids
+    ///  - when the lease was modified update it in the database
+    /// This function implements the new BLQ hook command named
+    /// "extended-info4-upgrade".
+    ///
     /// @param page_size The page size used for retrieval.
     /// @return The number of updates in the database.
     virtual size_t upgradeExtendedInfo(const LeasePageSize& page_size) override;