/*
This file is part of GNUnet
- (C) 2009, 2011 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2009, 2011 GNUnet e.V.
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
*/
/**
- * @file include/gnunet_datastore_plugin.h
- * @brief API for the database backend plugins.
* @author Christian Grothoff
+ *
+ * @file
+ * API for the database backend plugins.
+ *
+ * @defgroup datastore-plugin Data Store service plugin API
+ * API for the database backend plugins.
+ * @{
*/
#ifndef PLUGIN_DATASTORE_H
#define PLUGIN_DATASTORE_H
* @param delta change in disk utilization,
* 0 for "reset to empty"
*/
-typedef void (*DiskUtilizationChange) (void *cls, int delta);
+typedef void
+(*GNUNET_DATASTORE_DiskUtilizationChange) (void *cls,
+ int delta);
/**
/**
* Function to call on disk utilization change.
*/
- DiskUtilizationChange duc;
+ GNUNET_DATASTORE_DiskUtilizationChange duc;
/**
* Closure.
* @return #GNUNET_OK to keep the item
* #GNUNET_NO to delete the item
*/
-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);
+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
* 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 void (*PluginEstimateSize) (void *cls, unsigned long long *estimate);
+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,
+ const char *msg);
/**
* @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 for @a cont
*/
-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);
+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
+ * @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);
+typedef void
+(*PluginKeyProcessor) (void *cls,
+ const struct GNUNET_HashCode *key,
+ unsigned int count);
/**
* @param proc function to call on each key
* @param proc_cls closure for @a proc
*/
-typedef void (*PluginGetKeys) (void *cls,
- PluginKeyProcessor proc, void *proc_cls);
+typedef void
+(*PluginGetKeys) (void *cls,
+ PluginKeyProcessor proc,
+ void *proc_cls);
/**
* there may be!
* @param type entries of which type are relevant?
* Use 0 for any type.
- * @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 @a proc
*/
-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);
+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);
/**
* @param proc function to call the value (once only).
* @param proc_cls closure for @a proc
*/
-typedef void (*PluginGetRandom) (void *cls, PluginDatumProcessor proc,
- void *proc_cls);
+typedef void
+(*PluginGetRandom) (void *cls,
+ PluginDatumProcessor proc,
+ void *proc_cls);
+/**
+ * Update continuation.
+ *
+ * @param cls closure
+ * @param status #GNUNET_OK or #GNUNET_SYSERR
+ * @param msg error message on error
+ */
+typedef void
+(*PluginUpdateCont) (void *cls,
+ int status,
+ const char *msg);
/**
* @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);
/**
* @param proc function to call on the matching value
* @param proc_cls closure for @a 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);
/**
*
* @param cls closure
*/
-typedef void (*PluginDrop) (void *cls);
-
+typedef void
+(*PluginDrop) (void *cls);
/**
};
-
#endif
+
+/** @} */ /* end of group */
projects / oweals / gnunet.git / blobdiff