-remove GNUNET_MQ_impl_send_commit, make it part of send_continue, to ensure calling...

[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 bbf0ce2aac0b3b7f201d47ab7b6c5abef79fb9a0..082173fff2540f189e75c841e9136948fca1971b 100644 (file)
--- a/src/include/gnunet_datastore_plugin.h
+++ b/src/include/gnunet_datastore_plugin.h
@@ -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
@@ -88,11 +88,10 @@ struct GNUNET_DATASTORE_PluginEnvironment
  * @param anonymity anonymity-level for the content
  * @param expiration expiration time for the content
  * @param uid unique identifier for the datum
- *
- * @return GNUNET_OK to keep the item
- *         GNUNET_NO to delete the item
+ * @return #GNUNET_OK to keep the item
+ *         #GNUNET_NO to delete the item
  */
-typedef int (*PluginDatumProcessor) (void *cls, const GNUNET_HashCode * key,
+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,
@@ -116,7 +115,7 @@ typedef unsigned long long (*PluginEstimateSize) (void *cls);
  *
  * @param cls closure
  * @param key key for the item
- * @param size number of bytes in data
+ * @param size number of bytes in @a data
  * @param data content stored
  * @param type type of the content
  * @param priority priority of the content
@@ -124,10 +123,10 @@ typedef unsigned long long (*PluginEstimateSize) (void *cls);
  * @param replication replication-level for the content
  * @param expiration expiration time for the content
  * @param msg set to an error message (on failure)
- * @return GNUNET_OK on success,
- *         GNUNET_SYSERR on failure
+ * @return #GNUNET_OK on success,
+ *         #GNUNET_SYSERR on failure
  */
-typedef int (*PluginPut) (void *cls, const GNUNET_HashCode * key, uint32_t size,
+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,
@@ -141,9 +140,9 @@ typedef int (*PluginPut) (void *cls, const GNUNET_HashCode * key, uint32_t size,
  * @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 GNUNET_HashCode *key,
-                                  unsigned int count);
+typedef void (*PluginKeyProcessor) (void *cls,
+                                   const struct GNUNET_HashCode *key,
+                                   unsigned int count);
 
 
 /**
@@ -151,7 +150,7 @@ typedef void (*PluginKeyProcessor) (void *cls,
  *
  * @param cls closure
  * @param proc function to call on each key
- * @param proc_cls closure for proc
+ * @param proc_cls closure for @a proc
  */
 typedef void (*PluginGetKeys) (void *cls,
                               PluginKeyProcessor proc, void *proc_cls);
@@ -175,24 +174,24 @@ typedef void (*PluginGetKeys) (void *cls,
  *            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
+ * @param proc_cls closure for @a proc
  */
 typedef void (*PluginGetKey) (void *cls, uint64_t offset,
-                              const GNUNET_HashCode * key,
-                              const GNUNET_HashCode * vhash,
+                              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
- * NULL if no item applies, otherwise 'proc' is called once and only
+ * the specific implementation).  Calls @a proc with all values ZERO or
+ * NULL if no item applies, otherwise @a proc is called once and only
  * once with an item.
  *
  * @param cls closure
  * @param proc function to call the value (once only).
- * @param proc_cls closure for proc
+ * @param proc_cls closure for @a proc
  */
 typedef void (*PluginGetRandom) (void *cls, PluginDatumProcessor proc,
                                  void *proc_cls);
@@ -208,9 +207,6 @@ typedef void (*PluginGetRandom) (void *cls, PluginDatumProcessor proc,
  * priority should be added to the existing priority, ignoring the
  * priority in value.
  *
- * Note that it is possible for multiple values to match this put.
- * In that case, all of the respective values are updated.
- *
  * @param cls closure
  * @param uid unique identifier of the datum
  * @param delta by how much should the priority
@@ -221,7 +217,7 @@ typedef void (*PluginGetRandom) (void *cls, PluginDatumProcessor proc,
  *     MAX of any existing expiration time and
  *     this value
  * @param msg set to an error message (on error)
- * @return GNUNET_OK on success
+ * @return #GNUNET_OK on success
  */
 typedef int (*PluginUpdate) (void *cls, uint64_t uid, int delta,
                              struct GNUNET_TIME_Absolute expire, char **msg);
@@ -237,7 +233,7 @@ typedef int (*PluginUpdate) (void *cls, uint64_t uid, int delta,
  * @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
+ * @param proc_cls closure for @a proc
  */
 typedef void (*PluginGetType) (void *cls, uint64_t offset,
                                enum GNUNET_BLOCK_Type type,
@@ -326,7 +322,7 @@ struct GNUNET_DATASTORE_PluginFunctions
    * Iterate over all keys in the database.
    */
   PluginGetKeys get_keys;
-  
+
 };