-avoid 'hu', as it is unsigned short, not uint16_t

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

diff --git a/src/include/gnunet_peerstore_service.h b/src/include/gnunet_peerstore_service.h
index ff0add94208ccf606c3efd43bec521912ee5d87e..7a79a8b5679a2f646f00b8d075eba41d9f6af302 100644 (file)
--- a/src/include/gnunet_peerstore_service.h
+++ b/src/include/gnunet_peerstore_service.h
@@ -37,23 +37,92 @@ extern "C"
 #endif
 #endif
 
+/**
+ * Options for storing values in PEERSTORE
+ */
+enum GNUNET_PEERSTORE_StoreOption
+{
+
+  /**
+   * Possibly store multiple values under given key.
+   */
+  GNUNET_PEERSTORE_STOREOPTION_MULTIPLE,
+
+  /**
+   * Delete any previous values for the given key before
+   * storing the given value.
+   */
+  GNUNET_PEERSTORE_STOREOPTION_REPLACE,
+
+};
+
 /**
  * Handle to the peerstore service.
  */
 struct GNUNET_PEERSTORE_Handle;
 
 /**
- * Context for add requests
+ * Context for a store request
  */
-struct GNUNET_PEERSTORE_AddContext;
+struct GNUNET_PEERSTORE_StoreContext;
+
+/**
+ * Single PEERSTORE record
+ */
+struct GNUNET_PEERSTORE_Record
+{
+
+  /**
+   * Responsible sub system string
+   */
+  char *sub_system;
+
+  /**
+   * Peer Identity
+   */
+  struct GNUNET_PeerIdentity *peer;
+
+  /**
+   * Record key string
+   */
+  char *key;
+
+  /**
+   * Record value BLOB
+   */
+  void *value;
+
+  /**
+   * Size of 'value' BLOB
+   */
+  size_t value_size;
+
+  /**
+   * Expiry time of entry
+   */
+  struct GNUNET_TIME_Absolute *expiry;
+
+};
 
 /**
  * Continuation called with a status result.
  *
  * @param cls closure
- * @param emsg error message, NULL on success
+ * @param success #GNUNET_OK or #GNUNET_SYSERR
+ */
+typedef void (*GNUNET_PEERSTORE_Continuation)(void *cls, int success);
+
+/**
+ * Function called by for each matching record.
+ *
+ * @param cls closure
+ * @param record peerstore record information
+ * @param emsg error message, or NULL if no errors
+ * @return #GNUNET_YES to continue iterating, #GNUNET_NO to stop
  */
-typedef void (*GNUNET_PEERSTORE_Continuation)(void *cls, const char *emsg);
+typedef int (*GNUNET_PEERSTORE_Processor) (void *cls,
+    struct GNUNET_PEERSTORE_Record *record,
+    char *emsg);
 
 /**
  * Connect to the PEERSTORE service.
@@ -75,21 +144,25 @@ GNUNET_PEERSTORE_disconnect(struct GNUNET_PEERSTORE_Handle *h);
  * Store a new entry in the PEERSTORE
  *
  * @param h Handle to the PEERSTORE service
- * @param peer Peer Identity
  * @param sub_system name of the sub system
+ * @param peer Peer Identity
+ * @param key entry key
  * @param value entry value BLOB
  * @param size size of 'value'
- * @param lifetime relative time after which the entry is (possibly) deleted
+ * @param expiry absolute time after which the entry is (possibly) deleted
+ * @param options store operation option
  * @param cont Continuation function after the store request is processed
  * @param cont_cls Closure for 'cont'
  */
 struct GNUNET_PEERSTORE_StoreContext *
 GNUNET_PEERSTORE_store (struct GNUNET_PEERSTORE_Handle *h,
-    const struct GNUNET_PeerIdentity *peer,
     const char *sub_system,
+    const struct GNUNET_PeerIdentity *peer,
+    const char *key,
     const void *value,
     size_t size,
-    struct GNUNET_TIME_Relative lifetime,
+    struct GNUNET_TIME_Absolute expiry,
+    enum GNUNET_PEERSTORE_StoreOption options,
     GNUNET_PEERSTORE_Continuation cont,
     void *cont_cls);
 
@@ -101,6 +174,61 @@ GNUNET_PEERSTORE_store (struct GNUNET_PEERSTORE_Handle *h,
 void
 GNUNET_PEERSTORE_store_cancel (struct GNUNET_PEERSTORE_StoreContext *sc);
 
+/**
+ * Iterate over records matching supplied key information
+ *
+ * @param h handle to the PEERSTORE service
+ * @param sub_system name of sub system
+ * @param peer Peer identity (can be NULL)
+ * @param key entry key string (can be NULL)
+ * @param timeout time after which the iterate request is canceled
+ * @param callback function called with each matching record, all NULL's on end
+ * @param callback_cls closure for @a callback
+ */
+struct GNUNET_PEERSTORE_IterateContext *
+GNUNET_PEERSTORE_iterate (struct GNUNET_PEERSTORE_Handle *h,
+    const char *sub_system,
+    const struct GNUNET_PeerIdentity *peer,
+    const char *key,
+    struct GNUNET_TIME_Relative timeout,
+    GNUNET_PEERSTORE_Processor callback, void *callback_cls);
+
+/**
+ * Cancel an iterate request
+ * Please do not call after the iterate request is done
+ *
+ * @param ic Iterate request context as returned by GNUNET_PEERSTORE_iterate()
+ */
+void
+GNUNET_PEERSTORE_iterate_cancel (struct GNUNET_PEERSTORE_IterateContext *ic);
+
+/**
+ * Request watching a given key
+ * User will be notified with any new values added to key
+ *
+ * @param h handle to the PEERSTORE service
+ * @param sub_system name of sub system
+ * @param peer Peer identity
+ * @param key entry key string
+ * @param callback function called with each new value
+ * @param callback_cls closure for @a callback
+ * @return Handle to watch request
+ */
+struct GNUNET_PEERSTORE_WatchContext *
+GNUNET_PEERSTORE_watch (struct GNUNET_PEERSTORE_Handle *h,
+    const char *sub_system,
+    const struct GNUNET_PeerIdentity *peer,
+    const char *key,
+    GNUNET_PEERSTORE_Processor callback, void *callback_cls);
+
+/**
+ * Cancel a watch request
+ *
+ * @wc handle to the watch request
+ */
+void
+GNUNET_PEERSTORE_watch_cancel(struct GNUNET_PEERSTORE_WatchContext *wc);
+
 #if 0                           /* keep Emacsens' auto-indent happy */
 {
 #endif