-refactored

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

diff --git a/src/include/gnunet_peerstore_plugin.h b/src/include/gnunet_peerstore_plugin.h
index 8dcc1ec2a99b63e2511a44a5fd05e19f91859aeb..1d731f2cc78e531119376f467c32b1cfdda4f50f 100644 (file)
--- a/src/include/gnunet_peerstore_plugin.h
+++ b/src/include/gnunet_peerstore_plugin.h
@@ -1,6 +1,6 @@
 /*
      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
@@ -14,14 +14,19 @@
 
      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.
+     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+     Boston, MA 02110-1301, USA.
 */
 
 /**
- * @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
@@ -59,14 +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 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 key.
+   *
+   * @param cls closure (internal context for the plugin)
+   * @param sub_system name of sub system
+   * @param peer Peer identity (can be NULL)
+   * @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_SYSERR on error and iter is not
+   * called
+   */
+  int
+  (*iterate_records) (void *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);
 
 };
 
@@ -78,5 +130,6 @@ struct GNUNET_PEERSTORE_PluginFunctions
 }
 #endif
 
-/* end of gnunet_peerstore_plugin.h */
 #endif
+
+/** @} */  /* end of group */