X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_peerstore_plugin.h;h=bd5d18068b5c1f4cb577fcd177c649a79a75598f;hb=2bbb2934dbbe471640c67c3bc672120f35708fd1;hp=bf69675e46899265c1b9c786edb709a3f600f477;hpb=db2ee15ca4302b0e7fa78e318833cd136265b746;p=oweals%2Fgnunet.git

diff --git a/src/include/gnunet_peerstore_plugin.h b/src/include/gnunet_peerstore_plugin.h
index bf69675e4..bd5d18068 100644
--- a/src/include/gnunet_peerstore_plugin.h
+++ b/src/include/gnunet_peerstore_plugin.h
@@ -1,27 +1,32 @@
 /*
      This file is part of GNUnet
-     (C) 2012, 2013 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2012, 2013 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.
+     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, write to the
-     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-     Boston, MA 02111-1307, USA.
+     SPDX-License-Identifier: AGPL3.0-or-later
 */
 
 /**
- * @file include/gnunet_peerstore_plugin.h
- * @brief plugin API for the peerstore database backend
  * @author Omar Tarabai
+ *
+ * @file
+ * Plugin API for the peerstore database backend
+ *
+ * @defgroup peerstore-plugin  Peer Store service plugin API
+ * Plugin API for the peerstore database backend
+ * @{
  */
 #ifndef GNUNET_PEERSTORE_PLUGIN_H
 #define GNUNET_PEERSTORE_PLUGIN_H
@@ -38,21 +43,6 @@ extern "C"
 #endif
 
 
-/**
- * Function called by for each matching record.
- *
- * @param cls closure
- * @param peer peer identity
- * @param sub_system name of the GNUnet sub system responsible
- * @param value stored value
- * @param size size of stored value
- */
-typedef void (*GNUNET_PEERSTORE_RecordIterator) (void *cls,
-    const struct GNUNET_PeerIdentity *peer,
-    const char *sub_system,
-    const void *value,
-    size_t size);
-
 /**
  * @brief struct returned by the initialization function of the plugin
  */
@@ -74,32 +64,61 @@ struct GNUNET_PEERSTORE_PluginFunctions
    * @param peer peer identity
    * @param value value to be stored
    * @param size size of value to be stored
-   * @return #GNUNET_OK on success, else #GNUNET_SYSERR
+   * @param expiry absolute time after which the record is (possibly) deleted
+   * @param options options related to the store operation
+   * @param cont continuation called when record is stored
+   * @param cont_cls continuation closure
+   * @return #GNUNET_OK on success, else #GNUNET_SYSERR and cont is not called
    */
   int
   (*store_record) (void *cls,
-      const char *sub_system,
-      const struct GNUNET_PeerIdentity *peer,
-      const char *key,
-      const void *value,
-      size_t size);
+                   const char *sub_system,
+                   const struct GNUNET_PeerIdentity *peer,
+                   const char *key,
+                   const void *value,
+                   size_t size,
+                   struct GNUNET_TIME_Absolute expiry,
+                   enum GNUNET_PEERSTORE_StoreOption options,
+                   GNUNET_PEERSTORE_Continuation cont,
+                   void *cont_cls);
 
   /**
    * Iterate over the records given an optional peer id
-   * and/or sub system.
+   * and/or key.
    *
    * @param cls closure (internal context for the plugin)
+   * @param sub_system name of sub system
    * @param peer Peer identity (can be NULL)
-   * @param sub_system name of sub system (can be NULL)
-   * @param iter function to call with the result
+   * @param key entry key string (can be NULL)
+   * @param iter function to call asynchronously with the results, terminated
+   * by a NULL result
    * @param iter_cls closure for @a iter
-   * @return #GNUNET_OK on success, #GNUNET_NO if there were no results, #GNUNET_SYSERR on error
+   * @return #GNUNET_OK on success, #GNUNET_SYSERR on error and iter is not
+   * called
    */
   int
   (*iterate_records) (void *cls,
-      const struct GNUNET_PeerIdentity *peer,
-      const char *sub_system,
-      GNUNET_PEERSTORE_RecordIterator iter, void *iter_cls);
+                      const char *sub_system,
+                      const struct GNUNET_PeerIdentity *peer,
+                      const char *key,
+                      GNUNET_PEERSTORE_Processor iter,
+                      void *iter_cls);
+
+  /**
+   * Delete expired records (expiry < now)
+   *
+   * @param cls closure (internal context for the plugin)
+   * @param now time to use as reference
+   * @param cont continuation called with the number of records expired
+   * @param cont_cls continuation closure
+   * @return #GNUNET_OK on success, #GNUNET_SYSERR on error and cont is not
+   * called
+   */
+  int
+  (*expire_records) (void *cls,
+                     struct GNUNET_TIME_Absolute now,
+                     GNUNET_PEERSTORE_Continuation cont,
+                     void *cont_cls);
 
 };
 
@@ -111,5 +130,6 @@ struct GNUNET_PEERSTORE_PluginFunctions
 }
 #endif
 
-/* end of gnunet_peerstore_plugin.h */
 #endif
+
+/** @} */  /* end of group */