print active/inactive information

[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 dc232245992692f4ea3b78dc068c0767b15fe2f9..8eea796bb7857f13e7957af34d147f3d68509fc3 100644 (file)
--- a/src/include/gnunet_peerstore_plugin.h
+++ b/src/include/gnunet_peerstore_plugin.h
@@ -49,6 +49,58 @@ 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
+   * @return #GNUNET_OK on success, else #GNUNET_SYSERR
+   */
+  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);
+
+  /**
+   * 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 with the result
+   * @param iter_cls closure for @a iter
+   * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
+   */
+  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
+   * @return number of records deleted
+   */
+  int
+  (*expire_records) (void *cls,
+      struct GNUNET_TIME_Absolute now);
+
 };