/*
This file is part of GNUnet
- (C) 2009, 2011 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2009, 2011 Christian Grothoff (and other contributing authors)
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
* 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);
* @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,
* Get an estimate of how much space the database is
* currently using.
*
+ * NB: estimate is an output parameter because emscripten cannot handle
+ * returning 64-bit integers from dynamically loaded modules.
+ *
* @param cls closure
+ * @param estimate location to store estimate
* @return number of bytes used on disk
*/
-typedef unsigned long long (*PluginEstimateSize) (void *cls);
+typedef void (*PluginEstimateSize) (void *cls, unsigned long long *estimate);
+
+
+/**
+ * Put continuation.
+ *
+ * @param cls closure
+ * @param key key for the item stored
+ * @param size size of the item stored
+ * @param status GNUNET_OK or GNUNET_SYSERROR
+ * @param msg error message on error
+ */
+typedef void (*PluginPutCont) (void *cls, const struct GNUNET_HashCode *key,
+ uint32_t size, int status, char *msg);
/**
*
* @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
* @param anonymity anonymity-level for the content
* @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
+ * @param cont continuation called with success or failure status
+ * @param cont_cls continuation closure
+ */
+typedef void (*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,
+ PluginPutCont cont, void *cont_cls);
+
+
+/**
+ * An processor over a set of keys stored in the datastore.
+ *
+ * @param cls closure
+ * @param key key in the data store, if NULL iteration is finished
+ * @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 @a proc
*/
-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,
- uint32_t replication,
- struct GNUNET_TIME_Absolute expiration, char **msg);
+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
* 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 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);
+/**
+ * Update continuation.
+ *
+ * @param cls closure
+ * @param status GNUNET_OK or GNUNET_SYSERROR
+ * @param msg error message on error
+ */
+typedef void (*PluginUpdateCont) (void *cls, int status, char *msg);
+
+
/**
* Update the priority for a particular key in the datastore. If
* the expiration time in value is different than the time found in
* 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
* @param expire new expiration time should be the
* MAX of any existing expiration time and
* this value
- * @param msg set to an error message (on error)
- * @return GNUNET_OK on success
+ * @param cont continuation called with success or failure status
+ * @param cons_cls continuation closure
*/
-typedef int (*PluginUpdate) (void *cls, uint64_t uid, int delta,
- struct GNUNET_TIME_Absolute expire, char **msg);
+typedef void (*PluginUpdate) (void *cls, uint64_t uid, int delta,
+ struct GNUNET_TIME_Absolute expire,
+ PluginUpdateCont cont, void *cont_cls);
/**
* 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
+ * @param proc_cls closure for @a proc
*/
typedef void (*PluginGetType) (void *cls, uint64_t offset,
enum GNUNET_BLOCK_Type type,
*/
PluginDrop drop;
+ /**
+ * Iterate over all keys in the database.
+ */
+ PluginGetKeys get_keys;
+
};
projects / oweals / gnunet.git / blobdiff