Commit 8a7ca7c8 authored by Marcin Siodelski's avatar Marcin Siodelski

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

parent 834010d4
......@@ -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.
......
......@@ -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.
......
......@@ -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
......
......@@ -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
......
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