Merge branch 'credentials' of git+ssh://gnunet.org/gnunet into credentials
[oweals/gnunet.git] / src / datastore / plugin_datastore_template.c
index 8975c0a7015abc4887f6f9e039b030daab9eb976..fdd4fb157bf48021f41e81a23894890d486e353b 100644 (file)
@@ -1,6 +1,6 @@
 /*
      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
@@ -14,8 +14,8 @@
 
      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.
 */
 
 /**
@@ -31,7 +31,7 @@
 /**
  * Context for all functions in this plugin.
  */
-struct Plugin 
+struct Plugin
 {
   /**
    * Our execution environment.
@@ -47,11 +47,13 @@ struct Plugin
  * @param cls our "struct Plugin*"
  * @return number of bytes used on disk
  */
-static unsigned long long 
-template_plugin_estimate_size (void *cls)
+static void
+template_plugin_estimate_size (void *cls, unsigned long long *estimate)
 {
+  if (NULL == estimate)
+    return;
   GNUNET_break (0);
-  return 0;
+  *estimate = 0;
 }
 
 
@@ -67,24 +69,19 @@ template_plugin_estimate_size (void *cls)
  * @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 error message
- * @return GNUNET_OK on success
+ * @param cont continuation called with success or failure status
+ * @param cont_cls continuation closure
  */
-static int
-template_plugin_put (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)
+static void
+template_plugin_put (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)
 {
   GNUNET_break (0);
-  *msg = GNUNET_strdup ("not implemented");
-  return GNUNET_SYSERR;
+  cont (cont_cls, key, size, GNUNET_SYSERR, "not implemented");
 }
 
 
@@ -92,7 +89,7 @@ template_plugin_put (void *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 maybe NULL (to match all entries)
  * @param vhash hash of the value, maybe NULL (to
@@ -107,12 +104,11 @@ template_plugin_put (void *cls,
  * @param proc_cls closure for proc
  */
 static void
-template_plugin_get_key (void *cls,
-                        uint64_t offset,
-                        const GNUNET_HashCode * key,
-                        const GNUNET_HashCode * vhash,
-                        enum GNUNET_BLOCK_Type type,
-                        PluginDatumProcessor proc, void *proc_cls)
+template_plugin_get_key (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)
 {
   GNUNET_break (0);
 }
@@ -131,8 +127,8 @@ template_plugin_get_key (void *cls,
  * @param proc_cls closure for proc
  */
 static void
-template_plugin_get_replication (void *cls,
-                                PluginDatumProcessor proc, void *proc_cls)
+template_plugin_get_replication (void *cls, PluginDatumProcessor proc,
+                                 void *proc_cls)
 {
   GNUNET_break (0);
 }
@@ -147,8 +143,8 @@ template_plugin_get_replication (void *cls,
  * @param proc_cls closure for proc
  */
 static void
-template_plugin_get_expiration (void *cls,
-                               PluginDatumProcessor proc, void *proc_cls)
+template_plugin_get_expiration (void *cls, PluginDatumProcessor proc,
+                                void *proc_cls)
 {
   GNUNET_break (0);
 }
@@ -174,19 +170,16 @@ template_plugin_get_expiration (void *cls,
  * @param expire new expiration time should be the
  *     MAX of any existing expiration time and
  *     this value
- * @param msg set to error message
- * @return GNUNET_OK on success
+ * @param cont continuation called with success or failure status
+ * @param cons_cls continuation closure
  */
-static int
-template_plugin_update (void *cls,
-                       uint64_t uid,
-                       int delta, 
-                       struct GNUNET_TIME_Absolute expire,
-                       char **msg)
+static void
+template_plugin_update (void *cls, uint64_t uid, int delta,
+                        struct GNUNET_TIME_Absolute expire,
+                        PluginUpdateCont cont, void *cont_cls)
 {
   GNUNET_break (0);
-  *msg = GNUNET_strdup ("not implemented");
-  return GNUNET_SYSERR;
+  cont (cont_cls, GNUNET_SYSERR, "not implemented");
 }
 
 
@@ -194,7 +187,7 @@ template_plugin_update (void *cls,
  * Call the given processor on an item with zero anonymity.
  *
  * @param cls our "struct Plugin*"
- * @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?
  *        Use 0 for any type.
@@ -203,11 +196,9 @@ template_plugin_update (void *cls,
  * @param proc_cls closure for proc
  */
 static void
-template_plugin_get_zero_anonymity (void *cls,
-                                   uint64_t offset,
-                                   enum GNUNET_BLOCK_Type type,
-                                   PluginDatumProcessor proc,
-                                   void *proc_cls)
+template_plugin_get_zero_anonymity (void *cls, uint64_t offset,
+                                    enum GNUNET_BLOCK_Type type,
+                                    PluginDatumProcessor proc, void *proc_cls)
 {
   GNUNET_break (0);
 }
@@ -216,13 +207,29 @@ template_plugin_get_zero_anonymity (void *cls,
 /**
  * Drop database.
  */
-static void 
+static void
 template_plugin_drop (void *cls)
 {
   GNUNET_break (0);
 }
 
 
+/**
+ * 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
+ */
+static void
+template_get_keys (void *cls,
+                  PluginKeyProcessor proc,
+                  void *proc_cls)
+{
+  proc (proc_cls, NULL, 0);
+}
+
+
 /**
  * Entry point for the plugin.
  *
@@ -236,9 +243,9 @@ libgnunet_plugin_datastore_template_init (void *cls)
   struct GNUNET_DATASTORE_PluginFunctions *api;
   struct Plugin *plugin;
 
-  plugin = GNUNET_malloc (sizeof (struct Plugin));
+  plugin = GNUNET_new (struct Plugin);
   plugin->env = env;
-  api = GNUNET_malloc (sizeof (struct GNUNET_DATASTORE_PluginFunctions));
+  api = GNUNET_new (struct GNUNET_DATASTORE_PluginFunctions);
   api->cls = plugin;
   api->estimate_size = &template_plugin_estimate_size;
   api->put = &template_plugin_put;
@@ -248,8 +255,9 @@ libgnunet_plugin_datastore_template_init (void *cls)
   api->get_expiration = &template_plugin_get_expiration;
   api->get_zero_anonymity = &template_plugin_get_zero_anonymity;
   api->drop = &template_plugin_drop;
-  GNUNET_log_from (GNUNET_ERROR_TYPE_INFO,
-                   "template", _("Template database running\n"));
+  api->get_keys = &template_get_keys;
+  GNUNET_log_from (GNUNET_ERROR_TYPE_INFO, "template",
+                   _("Template database running\n"));
   return api;
 }