-code hygene
[oweals/gnunet.git] / src / include / gnunet_datacache_lib.h
index 3bd76df3284a0ef5e228a8dfff0f0fc65886d14c..533df0e597a73a5f798bbcc725eec49be91ffb26 100644 (file)
@@ -4,7 +4,7 @@
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
-     by the Free Software Foundation; either version 2, or (at your
+     by the Free Software Foundation; either version 3, or (at your
      option) any later version.
 
      GNUnet is distributed in the hope that it will be useful, but
@@ -32,6 +32,7 @@
 #define GNUNET_DATACACHE_LIB_H
 
 #include "gnunet_util_lib.h"
+#include "gnunet_block_lib.h"
 
 #ifdef __cplusplus
 extern "C"
@@ -51,15 +52,13 @@ struct GNUNET_DATACACHE_Handle;
 /**
  * Create a data cache.
  *
- * @param sched scheduler to use
  * @param cfg configuration to use
  * @param section section in the configuration that contains our options
  * @return handle to use to access the service
  */
 struct GNUNET_DATACACHE_Handle *
-GNUNET_DATACACHE_create (struct GNUNET_SCHEDULER_Handle *sched,
-                        const struct GNUNET_CONFIGURATION_Handle *cfg,
-                        const char *section);
+GNUNET_DATACACHE_create (const struct GNUNET_CONFIGURATION_Handle *cfg,
+                         const char *section);
 
 
 /**
@@ -67,26 +66,30 @@ GNUNET_DATACACHE_create (struct GNUNET_SCHEDULER_Handle *sched,
  *
  * @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
+ * @param exp when will the content expire?
+ * @param path_info_len number of entries in 'path_info'
+ * @param path_info a path through the network
  * @return GNUNET_OK to continue iterating, GNUNET_SYSERR to abort
  */
 typedef int (*GNUNET_DATACACHE_Iterator) (void *cls,
-                                         struct GNUNET_TIME_Absolute exp,
-                                         const GNUNET_HashCode * key,
-                                         uint32_t size,
-                                         const char *data,
-                                         uint32_t type);
+                                          const struct GNUNET_HashCode *key,
+                                          size_t size, const char *data,
+                                          enum GNUNET_BLOCK_Type type,
+                                          struct GNUNET_TIME_Absolute exp,
+                                         unsigned int path_info_len,
+                                         const struct GNUNET_PeerIdentity *path_info);
 
 
 /**
@@ -98,15 +101,17 @@ typedef int (*GNUNET_DATACACHE_Iterator) (void *cls,
  * @param data data to store
  * @param type type of the value
  * @param discard_time when to discard the value in any case
- * @return GNUNET_OK on success, GNUNET_SYSERR on error (full, etc.)
+ * @param path_info_len number of entries in 'path_info'
+ * @param path_info a path through the network
+ * @return GNUNET_OK on success, GNUNET_SYSERR on error, GNUNET_NO if duplicate
  */
-int 
+int
 GNUNET_DATACACHE_put (struct GNUNET_DATACACHE_Handle *h,
-                     const GNUNET_HashCode * key,
-                     uint32_t size,
-                     const char *data,
-                     unsigned int type,
-                     struct GNUNET_TIME_Absolute discard_time);
+                      const struct GNUNET_HashCode * key, size_t size,
+                      const char *data, enum GNUNET_BLOCK_Type type,
+                      struct GNUNET_TIME_Absolute discard_time,
+                     unsigned int path_info_len,
+                     const struct GNUNET_PeerIdentity *path_info);
 
 
 /**
@@ -120,12 +125,10 @@ GNUNET_DATACACHE_put (struct GNUNET_DATACACHE_Handle *h,
  * @param iter_cls closure for iter
  * @return the number of results found
  */
-unsigned int 
+unsigned int
 GNUNET_DATACACHE_get (struct GNUNET_DATACACHE_Handle *h,
-                     const GNUNET_HashCode * key,
-                     unsigned int type, 
-                     GNUNET_DATACACHE_Iterator iter,
-                     void *iter_cls);
+                      const struct GNUNET_HashCode * key, enum GNUNET_BLOCK_Type type,
+                      GNUNET_DATACACHE_Iterator iter, void *iter_cls);
 
 
 #if 0                           /* keep Emacsens' auto-indent happy */