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 9618f2b9f1c4b027c4c09387c1e0a71af90daff4..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
@@ -49,6 +49,71 @@ struct GNUNET_PEERSTORE_PluginFunctions
    */
   void *cls;
 
+  /**
+   * Store a record in the peerstore.
+   * Key is the combination of sub system and peer identity.
+   * One key can store multiple values.
+   *
+   * @param cls closure (internal context for the plugin)
+   * @param sub_system name of the GNUnet sub system responsible
+   * @param peer peer identity
+   * @param value value to be stored
+   * @param size size of value to be stored
+   * @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,
+      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);
+
 };
 
 
@@ -59,5 +124,5 @@ struct GNUNET_PEERSTORE_PluginFunctions
 }
 #endif
 
-/* end of gnunet_namestore_plugin.h */
+/* end of gnunet_peerstore_plugin.h */
 #endif