[#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 fe42783cf90261d1c065f36b8fedb44e7142d592..dca8b93f8941e9f4d3358df59c175e0606d023ad 100644 (file)
--- 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 15c06f03143b33de4ee9b3661ef6c57cc92d2552..e5831ecc065b1c4fbc4b7bfb4f147ec28f8c1e88 100644 (file)
--- 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 ba9f6773686226bef876ce76607722c0300197af..e4be9b5cb5abadc6ffab58c318b748ed9c01c751 100644 (file)
--- 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 794555abaa00be3c8eba8775abe39f4f7e15795c..e0534e22e08c3287c938b71bda1d8894f7a1206f 100644 (file)
--- 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;