doxy

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

diff --git a/src/include/gnunet_datastore_plugin.h b/src/include/gnunet_datastore_plugin.h
index f33588bce53835540bcd58f627a60090d8c93bff..efdcf896940dbd1cd7c3e0e258b9d16556576ba6 100644 (file)
--- a/src/include/gnunet_datastore_plugin.h
+++ b/src/include/gnunet_datastore_plugin.h
@@ -45,7 +45,7 @@
  * changes.
  *
  * @param cls closure
- * @param delta change in disk utilization, 
+ * @param delta change in disk utilization,
  *        0 for "reset to empty"
  */
 typedef void (*DiskUtilizationChange) (void *cls, int delta);
@@ -92,15 +92,12 @@ struct GNUNET_DATASTORE_PluginEnvironment
  * @return GNUNET_OK to keep the item
  *         GNUNET_NO to delete the item
  */
-typedef int (*PluginDatumProcessor) (void *cls,
-                                     const GNUNET_HashCode * key,
-                                     uint32_t size,
-                                     const void *data,
+typedef int (*PluginDatumProcessor) (void *cls, const struct GNUNET_HashCode * key,
+                                     uint32_t size, const void *data,
                                      enum GNUNET_BLOCK_Type type,
-                                     uint32_t priority,
-                                     uint32_t anonymity,
-                                     struct GNUNET_TIME_Absolute
-                                     expiration, uint64_t uid);
+                                     uint32_t priority, uint32_t anonymity,
+                                     struct GNUNET_TIME_Absolute expiration,
+                                     uint64_t uid);
 
 /**
  * Get an estimate of how much space the database is
@@ -130,22 +127,41 @@ typedef unsigned long long (*PluginEstimateSize) (void *cls);
  * @return GNUNET_OK on success,
  *         GNUNET_SYSERR on failure
  */
-typedef int (*PluginPut) (void *cls,
-                          const GNUNET_HashCode * key,
-                          uint32_t size,
-                          const void *data,
-                          enum GNUNET_BLOCK_Type type,
-                          uint32_t priority,
-                          uint32_t anonymity,
+typedef int (*PluginPut) (void *cls, const struct GNUNET_HashCode * key, uint32_t size,
+                          const void *data, enum GNUNET_BLOCK_Type type,
+                          uint32_t priority, uint32_t anonymity,
                           uint32_t replication,
                           struct GNUNET_TIME_Absolute expiration, char **msg);
 
 
+/**
+ * An processor over a set of keys stored in the datastore.
+ *
+ * @param cls closure
+ * @param key key in the data store
+ * @param count how many values are stored under this key in the datastore
+ */
+typedef void (*PluginKeyProcessor) (void *cls, 
+                                  const struct GNUNET_HashCode *key,
+                                  unsigned int count);
+
+
+/**
+ * Get all of the keys in the datastore.
+ *
+ * @param cls closure
+ * @param proc function to call on each key
+ * @param proc_cls closure for proc
+ */
+typedef void (*PluginGetKeys) (void *cls,
+                              PluginKeyProcessor proc, void *proc_cls);
+
+
 /**
  * Get one of the results for a particular key in the datastore.
  *
  * @param cls closure
- * @param offset offset of the result (modulo num-results); 
+ * @param offset offset of the result (modulo num-results);
  *               specific ordering does not matter for the offset
  * @param key key to match, never NULL
  * @param vhash hash of the value, maybe NULL (to
@@ -155,19 +171,19 @@ typedef int (*PluginPut) (void *cls,
  *        there may be!
  * @param type entries of which type are relevant?
  *     Use 0 for any type.
- * @param proc function to call on the matching value; 
+ * @param min find the smallest key that is larger than the given min,
+ *            NULL for no minimum (return smallest key)
+ * @param proc function to call on the matching value;
  *        proc should be called with NULL if there is no result
  * @param proc_cls closure for proc
  */
-typedef void (*PluginGetKey) (void *cls,
-                              uint64_t offset,
-                              const GNUNET_HashCode * key,
-                              const GNUNET_HashCode * vhash,
+typedef void (*PluginGetKey) (void *cls, uint64_t offset,
+                              const struct GNUNET_HashCode * key,
+                              const struct GNUNET_HashCode * vhash,
                               enum GNUNET_BLOCK_Type type,
                               PluginDatumProcessor proc, void *proc_cls);
 
 
-
 /**
  * Get a random item (additional constraints may apply depending on
  * the specific implementation).  Calls 'proc' with all values ZERO or
@@ -178,8 +194,10 @@ typedef void (*PluginGetKey) (void *cls,
  * @param proc function to call the value (once only).
  * @param proc_cls closure for proc
  */
-typedef void (*PluginGetRandom) (void *cls,
-                                 PluginDatumProcessor proc, void *proc_cls);
+typedef void (*PluginGetRandom) (void *cls, PluginDatumProcessor proc,
+                                 void *proc_cls);
+
+
 
 
 /**
@@ -205,26 +223,23 @@ typedef void (*PluginGetRandom) (void *cls,
  * @param msg set to an error message (on error)
  * @return GNUNET_OK on success
  */
-typedef int (*PluginUpdate) (void *cls,
-                             uint64_t uid,
-                             int delta,
+typedef int (*PluginUpdate) (void *cls, uint64_t uid, int delta,
                              struct GNUNET_TIME_Absolute expire, char **msg);
 
 
 /**
  * Select a single item from the datastore at the specified offset
- * (among those applicable). 
+ * (among those applicable).
  *
  * @param cls closure
- * @param offset offset of the result (modulo num-results); 
+ * @param offset offset of the result (modulo num-results);
  *               specific ordering does not matter for the offset
  * @param type entries of which type should be considered?
  *        Must not be zero (ANY).
  * @param proc function to call on the matching value
  * @param proc_cls closure for proc
  */
-typedef void (*PluginGetType) (void *cls,
-                               uint64_t offset,
+typedef void (*PluginGetType) (void *cls, uint64_t offset,
                                enum GNUNET_BLOCK_Type type,
                                PluginDatumProcessor proc, void *proc_cls);
 
@@ -307,6 +322,11 @@ struct GNUNET_DATASTORE_PluginFunctions
    */
   PluginDrop drop;
 
+  /**
+   * Iterate over all keys in the database.
+   */
+  PluginGetKeys get_keys;
+  
 };