* 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);
+typedef void (*DiskUtilizationChange) (void *cls, int delta);
/**
* @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,
- enum GNUNET_BLOCK_Type type,
- uint32_t priority,
- uint32_t anonymity,
- struct GNUNET_TIME_Absolute
- expiration,
- uint64_t uid);
+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);
/**
* Get an estimate of how much space the database is
* @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,
- uint32_t replication,
- struct GNUNET_TIME_Absolute expiration,
- char **msg);
+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 (mod #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 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,
- enum GNUNET_BLOCK_Type type,
- PluginDatumProcessor proc, void *proc_cls);
-
+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
* NULL if no item applies, otherwise 'proc' is called once and only
- * once with an item, with the 'next_cls' argument being NULL.
+ * once with an item.
*
* @param cls closure
* @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);
+
+
/**
* @param msg set to an error message (on error)
* @return GNUNET_OK on success
*/
-typedef int (*PluginUpdate) (void *cls,
- uint64_t uid,
- int delta,
- struct GNUNET_TIME_Absolute expire,
- char **msg);
+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 (mod #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,
- enum GNUNET_BLOCK_Type type,
- PluginDatumProcessor proc,
- void *proc_cls);
+typedef void (*PluginGetType) (void *cls, uint64_t offset,
+ enum GNUNET_BLOCK_Type type,
+ PluginDatumProcessor proc, void *proc_cls);
/**
/**
* Get datum (of the specified type) with anonymity level zero.
+ * This function is allowed to ignore the 'offset' argument
+ * and instead return a random result (with zero anonymity of
+ * the correct type) if implementing an offset is expensive.
*/
PluginGetType get_zero_anonymity;
PluginGetRandom get_replication;
/**
- * Function to get a random expired item or, if none are expired, one
- * with a low priority.
+ * Function to get a random expired item or, if none are expired,
+ * either the oldest entry or one with a low priority (depending
+ * on what was efficiently implementable).
*/
PluginGetRandom get_expiration;
*/
PluginDrop drop;
+ /**
+ * Iterate over all keys in the database.
+ */
+ PluginGetKeys get_keys;
+
};
projects / oweals / gnunet.git / blobdiff