[#717,!417] Documented server selectors allowed for subnets.

diff --git a/src/hooks/dhcp/mysql_cb/mysql_cb_dhcp4.h b/src/hooks/dhcp/mysql_cb/mysql_cb_dhcp4.h
index 697cca438d5d5d1c32adf6e27a0bf20f0dd8ce9d..dfb034d02db13ae1a9718ad31033ac72895fff01 100644 (file)
--- a/src/hooks/dhcp/mysql_cb/mysql_cb_dhcp4.h
+++ b/src/hooks/dhcp/mysql_cb/mysql_cb_dhcp4.h
@@ -75,7 +75,7 @@ public:
     /// for the given shared network are returned regardless of their
     /// associations with the servers.
     ///
-    /// @param server_selector Server selector.
+    /// @param server_selector Server selector (currently ignored).
     /// @param shared_network_name Name of the shared network for which the
     /// subnets should be retrieved.
     /// @return Collection of subnets or empty collection if no subnet found.

diff --git a/src/hooks/dhcp/mysql_cb/mysql_cb_dhcp6.h b/src/hooks/dhcp/mysql_cb/mysql_cb_dhcp6.h
index 1b4d6bdc1fd1f5d1f4e5b5d2b92bb45f8e4347c3..42d340e0991e381e0bb57a50818ce4265c1664bb 100644 (file)
--- a/src/hooks/dhcp/mysql_cb/mysql_cb_dhcp6.h
+++ b/src/hooks/dhcp/mysql_cb/mysql_cb_dhcp6.h
@@ -75,7 +75,7 @@ public:
     /// for the given shared network are returned regardless of their
     /// associations with the servers.
     ///
-    /// @param server_selector Server selector.
+    /// @param server_selector Server selector (currently ignored).
     /// @param shared_network_name Name of the shared network for which the
     /// subnets should be retrieved.
     /// @return Collection of subnets or empty collection if no subnet found.

diff --git a/src/lib/dhcpsrv/config_backend_dhcp4.h b/src/lib/dhcpsrv/config_backend_dhcp4.h
index 45527a584f3c971cc6f80e3c093672fcc94508be..8551d22351a08cff03d8b4e5c24b034768cdffc9 100644 (file)
--- a/src/lib/dhcpsrv/config_backend_dhcp4.h
+++ b/src/lib/dhcpsrv/config_backend_dhcp4.h
@@ -90,6 +90,9 @@ public:
 
     /// @brief Retrieves a single subnet by subnet_prefix.
     ///
+    /// Allowed server selectors: ANY, UNASSIGNED, ALL, ONE.
+    /// Not allowed server selector: MULTIPLE.
+    ///
     /// @param server_selector Server selector.
     /// @param subnet_prefix Prefix of the subnet to be retrieved.
     /// @return Pointer to the retrieved subnet or NULL if not found.
@@ -99,6 +102,9 @@ public:
 
     /// @brief Retrieves a single subnet by subnet identifier.
     ///
+    /// Allowed server selectors: ANY, UNASSIGNED, ALL, ONE.
+    /// Not allowed server selector: MULTIPLE.
+    ///
     /// @param server_selector Server selector.
     /// @param subnet_id Identifier of a subnet to be retrieved.
     /// @return Pointer to the retrieved subnet or NULL if not found.
@@ -107,6 +113,9 @@ public:
 
     /// @brief Retrieves all subnets.
     ///
+    /// Allowed server selectors: UNASSIGNED, ALL, ONE, MULTIPLE.
+    /// Not allowed server selector: ANY.
+    ///
     /// @param server_selector Server selector.
     /// @return Collection of subnets or empty collection if no subnet found.
     virtual Subnet4Collection
@@ -114,6 +123,9 @@ public:
 
     /// @brief Retrieves all subnets belonging to a specified shared network.
     ///
+    /// Allowed server selectors:ANY.
+    /// Not allowed server selectors: UNASSIGNED, ALL, ONE, MULTIPLE.
+    ///
     /// @param server_selector Server selector.
     /// @param shared_network_name Name of the shared network for which the
     /// subnets should be retrieved.
@@ -124,6 +136,9 @@ public:
 
     /// @brief Retrieves subnets modified after specified time.
     ///
+    /// Allowed server selectors: UNASSIGNED, ALL, ONE, MULTIPLE.
+    /// Not allowed server selector: ANY.
+    ///
     /// @param server_selector Server selector.
     /// @param modification_time Lower bound subnet modification time.
     /// @return Collection of subnets or empty collection if no subnet found.
@@ -310,6 +325,9 @@ public:
 
     /// @brief Creates or updates a subnet.
     ///
+    /// Allowed server selectors: UNASSIGNED, ALL, ONE, MULTIPLE.
+    /// Not allowed server selector: ANY.
+    ///
     /// @param server_selector Server selector.
     /// @param subnet Subnet to be added or updated.
     virtual void
@@ -394,6 +412,9 @@ public:
 
     /// @brief Deletes subnet by prefix.
     ///
+    /// Allowed server selectors: ANY, UNASSIGNED, ALL, ONE.
+    /// Not allowed server selectors: MULTIPLE.
+    ///
     /// @param server_selector Server selector.
     /// @param subnet_prefix Prefix of the subnet to be deleted.
     /// @return Number of deleted subnets.
@@ -403,6 +424,9 @@ public:
 
     /// @brief Deletes subnet by identifier.
     ///
+    /// Allowed server selectors: ANY, UNASSIGNED, ALL, ONE.
+    /// Not allowed server selectors: MULTIPLE.
+    ///
     /// @param server_selector Server selector.
     /// @param subnet_id Identifier of the subnet to be deleted.
     /// @return Number of deleted subnets.
@@ -411,6 +435,9 @@ public:
 
     /// @brief Deletes all subnets.
     ///
+    /// Allowed server selectors: UNASSIGNED, ALL, ONE.
+    /// Not allowed server selectors: ANY, MULTIPLE.
+    ///
     /// @param server_selector Server selector.
     /// @return Number of deleted subnets.
     virtual uint64_t

diff --git a/src/lib/dhcpsrv/config_backend_dhcp6.h b/src/lib/dhcpsrv/config_backend_dhcp6.h
index fd25b6a867014287e87fb8c40dff06a69fe47756..2d88147bd2feb9f40a19d30079d009021801ccd6 100644 (file)
--- a/src/lib/dhcpsrv/config_backend_dhcp6.h
+++ b/src/lib/dhcpsrv/config_backend_dhcp6.h
@@ -91,6 +91,9 @@ public:
 
     /// @brief Retrieves a single subnet by subnet_prefix.
     ///
+    /// Allowed server selectors: ANY, UNASSIGNED, ALL, ONE.
+    /// Not allowed server selector: MULTIPLE.
+    ///
     /// @param server_selector Server selector.
     /// @param subnet_prefix Prefix of the subnet to be retrieved.
     /// @return Pointer to the retrieved subnet or NULL if not found.
@@ -100,6 +103,9 @@ public:
 
     /// @brief Retrieves a single subnet by subnet identifier.
     ///
+    /// Allowed server selectors: ANY, UNASSIGNED, ALL, ONE.
+    /// Not allowed server selector: MULTIPLE.
+    ///
     /// @param server_selector Server selector.
     /// @param subnet_id Identifier of a subnet to be retrieved.
     /// @return Pointer to the retrieved subnet or NULL if not found.
@@ -108,6 +114,9 @@ public:
 
     /// @brief Retrieves all subnets.
     ///
+    /// Allowed server selectors: UNASSIGNED, ALL, ONE, MULTIPLE.
+    /// Not allowed server selector: ANY.
+    ///
     /// @param server_selector Server selector.
     /// @return Collection of subnets or empty collection if no subnet found.
     virtual Subnet6Collection
@@ -115,6 +124,9 @@ public:
 
     /// @brief Retrieves all subnets belonging to a specified shared network.
     ///
+    /// Allowed server selectors:ANY.
+    /// Not allowed server selectors: UNASSIGNED, ALL, ONE, MULTIPLE.
+    ///
     /// @param server_selector Server selector.
     /// @param shared_network_name Name of the shared network for which the
     /// subnets should be retrieved.
@@ -311,6 +323,9 @@ public:
 
     /// @brief Creates or updates a subnet.
     ///
+    /// Allowed server selectors: UNASSIGNED, ALL, ONE, MULTIPLE.
+    /// Not allowed server selector: ANY.
+    ///
     /// @param server_selector Server selector.
     /// @param subnet Subnet to be added or updated.
     virtual void
@@ -409,6 +424,9 @@ public:
 
     /// @brief Deletes subnet by prefix.
     ///
+    /// Allowed server selectors: ANY, UNASSIGNED, ALL, ONE.
+    /// Not allowed server selectors: MULTIPLE.
+    ///
     /// @param server_selector Server selector.
     /// @param subnet_prefix Prefix of the subnet to be deleted.
     /// @return Number of deleted subnets.
@@ -418,6 +436,9 @@ public:
 
     /// @brief Deletes subnet by identifier.
     ///
+    /// Allowed server selectors: ANY, UNASSIGNED, ALL, ONE.
+    /// Not allowed server selectors: MULTIPLE.
+    ///
     /// @param server_selector Server selector.
     /// @param subnet_id Identifier of the subnet to be deleted.
     /// @return Number of deleted subnets.
@@ -426,6 +447,9 @@ public:
 
     /// @brief Deletes all subnets.
     ///
+    /// Allowed server selectors: UNASSIGNED, ALL, ONE.
+    /// Not allowed server selectors: ANY, MULTIPLE.
+    ///
     /// @param server_selector Server selector.
     /// @return Number of deleted subnets.
     virtual uint64_t