]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[5208a] return comments updated
authorTomek Mrugalski <tomasz@isc.org>
Mon, 24 Apr 2017 17:56:47 +0000 (19:56 +0200)
committerTomek Mrugalski <tomasz@isc.org>
Mon, 24 Apr 2017 17:56:47 +0000 (19:56 +0200)
src/lib/dhcpsrv/base_host_data_source.h
src/lib/dhcpsrv/mysql_host_data_source.h
src/lib/dhcpsrv/pgsql_host_data_source.h

index 922c17aa956ceb2fd64ab066061b47dc0fb5292e..3dd7f2e3126f88244f3f99384dd326c739e3628c 100644 (file)
@@ -253,7 +253,8 @@ public:
     ///
     /// @param subnet_id subnet identfier.
     /// @param addr specified address.
-    /// @return true if deletion was successful, false otherwise.
+    /// @return true if deletion was successful, false if the host was not there.
+    /// @throw various exceptions in case of errors
     virtual bool del(const SubnetID& subnet_id, const asiolink::IOAddress& addr) = 0;
 
     /// @brief Attempts to delete a host by (subnet-id4, identifier, identifier-type)
@@ -265,7 +266,8 @@ public:
     /// @param identifier_begin Pointer to a beginning of a buffer containing
     /// an identifier.
     /// @param identifier_len Identifier length.
-    /// @return true if deletion was successful, false otherwise.
+    /// @return true if deletion was successful, false if the host was not there.
+    /// @throw various exceptions in case of errors
     virtual bool del4(const SubnetID& subnet_id,
                       const Host::IdentifierType& identifier_type,
                       const uint8_t* identifier_begin, const size_t identifier_len) = 0;
@@ -279,12 +281,12 @@ public:
     /// @param identifier_begin Pointer to a beginning of a buffer containing
     /// an identifier.
     /// @param identifier_len Identifier length.
-    /// @return true if deletion was successful, false otherwise.
+    /// @return true if deletion was successful, false if the host was not there.
+    /// @throw various exceptions in case of errors
     virtual bool del6(const SubnetID& subnet_id,
                       const Host::IdentifierType& identifier_type,
                       const uint8_t* identifier_begin, const size_t identifier_len) = 0;
 
-
     /// @brief Return backend type
     ///
     /// Returns the type of the backend (e.g. "mysql", "memfile" etc.)
index f053827d9872a68eaba5d33f2e6eb831e97d32bf..854f4b968a2f0aa0689af8b0da5e9139da9b8bca 100644 (file)
@@ -226,7 +226,8 @@ public:
     ///
     /// @param subnet_id subnet identfier.
     /// @param addr specified address.
-    /// @return true if deletion was successful, false otherwise.
+    /// @return true if deletion was successful, false if the host was not there.
+    /// @throw various exceptions in case of errors
     virtual bool del(const SubnetID& subnet_id, const asiolink::IOAddress& addr);
 
     /// @brief Attempts to delete a host by (subnet4-id, identifier type, identifier)
@@ -235,7 +236,8 @@ public:
     ///
     /// @param subnet_id subnet identfier.
     /// @param addr specified address.
-    /// @return true if deletion was successful, false otherwise.
+    /// @return true if deletion was successful, false if the host was not there.
+    /// @throw various exceptions in case of errors
     virtual bool del4(const SubnetID& subnet_id,
                       const Host::IdentifierType& identifier_type,
                       const uint8_t* identifier_begin, const size_t identifier_len);
@@ -246,7 +248,8 @@ public:
     ///
     /// @param subnet_id subnet identfier.
     /// @param addr specified address.
-    /// @return true if deletion was successful, false otherwise.
+    /// @return true if deletion was successful, false if the host was not there.
+    /// @throw various exceptions in case of errors
     virtual bool del6(const SubnetID& subnet_id,
                       const Host::IdentifierType& identifier_type,
                       const uint8_t* identifier_begin, const size_t identifier_len);
index cfed1ca5f524c07d527f9ed724c3c01d0775e530..c5f4253f6d8d18d604dd9544da3a9d05a9e9bc1b 100644 (file)
@@ -257,7 +257,8 @@ public:
     ///
     /// @param subnet_id subnet identfier.
     /// @param addr specified address.
-    /// @return true if deletion was successful, false otherwise.
+    /// @return true if deletion was successful, false if the host was not there.
+    /// @throw various exceptions in case of errors
     virtual bool del(const SubnetID& subnet_id, const asiolink::IOAddress& addr);
 
     /// @brief Attempts to delete a host by (subnet4-id, identifier type, identifier)
@@ -266,7 +267,8 @@ public:
     ///
     /// @param subnet_id subnet identfier.
     /// @param addr specified address.
-    /// @return true if deletion was successful, false otherwise.
+    /// @return true if deletion was successful, false if the host was not there.
+    /// @throw various exceptions in case of errors
     virtual bool del4(const SubnetID& subnet_id,
                       const Host::IdentifierType& identifier_type,
                       const uint8_t* identifier_begin, const size_t identifier_len);
@@ -277,7 +279,8 @@ public:
     ///
     /// @param subnet_id subnet identfier.
     /// @param addr specified address.
-    /// @return true if deletion was successful, false otherwise.
+    /// @return true if deletion was successful, false if the host was not there.
+    /// @throw various exceptions in case of errors
     virtual bool del6(const SubnetID& subnet_id,
                       const Host::IdentifierType& identifier_type,
                       const uint8_t* identifier_begin, const size_t identifier_len);