doxy

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

diff --git a/src/include/gnunet_datacache_lib.h b/src/include/gnunet_datacache_lib.h
index 64d1d48834a9330ac3c96b962b5984a4187b9890..071b304be23ae3d59ccb9eb4185639f33b41556f 100644 (file)
--- a/src/include/gnunet_datacache_lib.h
+++ b/src/include/gnunet_datacache_lib.h
@@ -32,6 +32,7 @@
 #define GNUNET_DATACACHE_LIB_H
 
 #include "gnunet_util_lib.h"
+#include "gnunet_block_lib.h"
 
 #ifdef __cplusplus
 extern "C"
@@ -56,8 +57,8 @@ struct GNUNET_DATACACHE_Handle;
  * @return handle to use to access the service
  */
 struct GNUNET_DATACACHE_Handle *
-GNUNET_DATACACHE_create (struct GNUNET_CONFIGURATION_Handle *cfg,
-                        const char *section);
+GNUNET_DATACACHE_create (const struct GNUNET_CONFIGURATION_Handle *cfg,
+                         const char *section);
 
 
 /**
@@ -65,28 +66,32 @@ GNUNET_DATACACHE_create (struct GNUNET_CONFIGURATION_Handle *cfg,
  *
  * @param h handle to the datastore
  */
-void GNUNET_DATACACHE_destroy (struct GNUNET_DATACACHE_Handle *h);
+void
+GNUNET_DATACACHE_destroy (struct GNUNET_DATACACHE_Handle *h);
 
 
 /**
  * An iterator over a set of items stored in the datacache.
  *
  * @param cls closure
+ * @param exp when will the content expire?
  * @param key key for the content
  * @param size number of bytes in data
  * @param data content stored
  * @param type type of the content
+ * @return GNUNET_OK to continue iterating, GNUNET_SYSERR to abort
  */
-typedef void (*GNUNET_DATACACHE_Iterator) (void *cls,
-                                          const GNUNET_HashCode * key,
-                                          uint32_t size,
-                                          const char *data,
-                                          uint32_t type);
+typedef int (*GNUNET_DATACACHE_Iterator) (void *cls,
+                                          struct GNUNET_TIME_Absolute exp,
+                                          const struct GNUNET_HashCode * key,
+                                          size_t size, const char *data,
+                                          enum GNUNET_BLOCK_Type type);
 
 
 /**
- * Store an item in the datastore.
+ * Store an item in the datacache.
  *
+ * @param h handle to the datacache
  * @param key key to store data under
  * @param size number of bytes in data
  * @param data data to store
@@ -94,29 +99,28 @@ typedef void (*GNUNET_DATACACHE_Iterator) (void *cls,
  * @param discard_time when to discard the value in any case
  * @return GNUNET_OK on success, GNUNET_SYSERR on error (full, etc.)
  */
-int 
-GNUNET_DATACACHE_put (const GNUNET_HashCode * key,
-                     uint32_t size,
-                     const char *data,
-                     unsigned int type,
-                     struct GNUNET_TIME_Absolute discard_time);
+int
+GNUNET_DATACACHE_put (struct GNUNET_DATACACHE_Handle *h,
+                      const struct GNUNET_HashCode * key, size_t size,
+                      const char *data, enum GNUNET_BLOCK_Type type,
+                      struct GNUNET_TIME_Absolute discard_time);
 
 
 /**
  * Iterate over the results for a particular key
- * in the datastore.
+ * in the datacache.
  *
+ * @param h handle to the datacache
  * @param key what to look up
  * @param type entries of which type are relevant?
  * @param iter maybe NULL (to just count)
  * @param iter_cls closure for iter
  * @return the number of results found
  */
-unsigned int 
-GNUNET_DATACACHE_get (const GNUNET_HashCode * key,
-                     unsigned int type, 
-                     GNUNET_DATACACHE_Iterator iter,
-                     void *iter_cls);
+unsigned int
+GNUNET_DATACACHE_get (struct GNUNET_DATACACHE_Handle *h,
+                      const struct GNUNET_HashCode * key, enum GNUNET_BLOCK_Type type,
+                      GNUNET_DATACACHE_Iterator iter, void *iter_cls);
 
 
 #if 0                           /* keep Emacsens' auto-indent happy */