RECLAIM/OIDC: code cleanup

[oweals/gnunet.git] / src / include / gnunet_db_lib.h

diff --git a/src/include/gnunet_db_lib.h b/src/include/gnunet_db_lib.h
index 71ac4aae9f59ed93e10f3a28952b8e8f46010b52..ea3b8d519ebdd24c40a2c4407517b15e6e3ed996 100644 (file)
--- a/src/include/gnunet_db_lib.h
+++ b/src/include/gnunet_db_lib.h
@@ -2,16 +2,20 @@
   This file is part of GNUnet
   Copyright (C) 2017 GNUnet e.V.
 
-  GNUnet is free software; you can redistribute it and/or modify it under the
-  terms of the GNU General Public License as published by the Free Software
-  Foundation; either version 3, or (at your option) any later version.
+  GNUnet is free software: you can redistribute it and/or modify it
+  under the terms of the GNU Affero General Public License as published
+  by the Free Software Foundation, either version 3 of the License,
+  or (at your option) any later version.
 
-  GNUnet is distributed in the hope that it will be useful, but WITHOUT ANY
-  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
-  A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+  GNUnet is distributed in the hope that it will be useful, but
+  WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+  Affero General Public License for more details.
+ 
+  You should have received a copy of the GNU Affero General Public License
+  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-  You should have received a copy of the GNU General Public License along with
-  GNUnet; see the file COPYING.  If not, If not, see <http://www.gnu.org/licenses/>
+     SPDX-License-Identifier: AGPL3.0-or-later
 */
 /**
  * @file include/gnunet_db_lib.h
@@ -25,7 +29,7 @@
 /**
  * Status code returned from functions running database commands.
  * Can be combined with a function that returns the number
- * of results, so non-negative values indicate success.
+ * of results, so all non-negative values indicate success.
  */
 enum GNUNET_DB_QueryStatus
 {
@@ -36,11 +40,15 @@ enum GNUNET_DB_QueryStatus
 
   /**
    * A soft error occurred, retrying the transaction may succeed.
+   * Includes DEADLOCKS and SERIALIZATION errors.
    */
   GNUNET_DB_STATUS_SOFT_ERROR = -1,
 
   /**
    * The transaction succeeded, but yielded zero results.
+   * May include the case where an INSERT failed with UNIQUE
+   * violation (i.e. row already exists) or where DELETE
+   * failed to remove anything (i.e. nothing matched).
    */
   GNUNET_DB_STATUS_SUCCESS_NO_RESULTS = 0,
 
@@ -49,6 +57,9 @@ enum GNUNET_DB_QueryStatus
    */
   GNUNET_DB_STATUS_SUCCESS_ONE_RESULT = 1
 
+  /* Larger values may be returned for SELECT statements
+     that returned more than one result. */
+
 };
 
 #endif