client_manager: add API for async operations

[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 9371f69317817227273613442485c52b18eea073..99f01aea481cc74d33d230ead84dd762839aa4fe 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 Christian Grothoff (and other contributing authors)
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
@@ -38,22 +38,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 char *sub_system,
-    const struct GNUNET_PeerIdentity *peer,
-    const char *key,
-    const void *value,
-    size_t size);
-
 /**
  * @brief struct returned by the initialization function of the plugin
  */
@@ -75,7 +59,11 @@ 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,
@@ -83,7 +71,11 @@ struct GNUNET_PEERSTORE_PluginFunctions
       const struct GNUNET_PeerIdentity *peer,
       const char *key,
       const void *value,
-      size_t size);
+      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
@@ -93,16 +85,34 @@ struct GNUNET_PEERSTORE_PluginFunctions
    * @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 with the result
+   * @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
+   * @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_RecordIterator iter, void *iter_cls);
+      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);
 
 };