Merge branch 'credentials' of git+ssh://gnunet.org/gnunet into credentials

[oweals/gnunet.git] / src / datastore / plugin_datastore_template.c

diff --git a/src/datastore/plugin_datastore_template.c b/src/datastore/plugin_datastore_template.c
index 7656f6a7dcf89a2c8d48422d2e4d5751282e324d..fdd4fb157bf48021f41e81a23894890d486e353b 100644 (file)
--- a/src/datastore/plugin_datastore_template.c
+++ b/src/datastore/plugin_datastore_template.c
@@ -1,10 +1,10 @@
 /*
      This file is part of GNUnet
 /*
      This file is part of GNUnet

-     (C) 2009 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
 
      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
      option) any later version.
 
      GNUnet is distributed in the hope that it will be useful, but


@@ -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
 
      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.

 */
 
 /**
 */
 
 /**


@@ -25,13 +25,13 @@
  */
 
 #include "platform.h"
  */
 
 #include "platform.h"

-#include "plugin_datastore.h"
+#include "gnunet_datastore_plugin.h"

 
 
 /**
  * Context for all functions in this plugin.
  */
 
 
 /**
  * Context for all functions in this plugin.
  */

-struct Plugin 
+struct Plugin

 {
   /**
    * Our execution environment.
 {
   /**
    * Our execution environment.


@@ -47,10 +47,13 @@ struct Plugin
  * @param cls our "struct Plugin*"
  * @return number of bytes used on disk
  */
  * @param cls our "struct Plugin*"
  * @return number of bytes used on disk
  */

-static unsigned long long template_plugin_get_size (void *cls)
+static void
+template_plugin_estimate_size (void *cls, unsigned long long *estimate)

 {
 {

+  if (NULL == estimate)
+    return;

   GNUNET_break (0);
   GNUNET_break (0);

-  return 0;
+  *estimate = 0;

 }
 
 
 }
 
 


@@ -64,52 +67,30 @@ static unsigned long long template_plugin_get_size (void *cls)
  * @param type type of the content
  * @param priority priority of the content
  * @param anonymity anonymity-level for the content
  * @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 expiration expiration time for the content

- * @param msg set to error message
- * @return GNUNET_OK on success
- */
-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,
-                    struct GNUNET_TIME_Absolute expiration,
-                    char **msg)
-{
-  GNUNET_break (0);
-  *msg = GNUNET_strdup ("not implemented");
-  return GNUNET_SYSERR;
-}
-
-
-/**
- * Function invoked on behalf of a "PluginIterator"
- * asking the database plugin to call the iterator
- * with the next item.
- *
- * @param next_cls whatever argument was given
- *        to the PluginIterator as "next_cls".
- * @param end_it set to GNUNET_YES if we
- *        should terminate the iteration early
- *        (iterator should be still called once more
- *         to signal the end of the iteration).
+ * @param cont continuation called with success or failure status
+ * @param cont_cls continuation closure

  */
  */

-static void 
-template_plugin_next_request (void *next_cls,
-                      int end_it)
+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);
 {
   GNUNET_break (0);

+  cont (cont_cls, key, size, GNUNET_SYSERR, "not implemented");

 }
 
 
 /**
 }
 
 
 /**

- * Iterate over the results for a particular key
- * in the datastore.
+ * Get one of the results for a particular key in the datastore.

  *
  * @param cls closure
  *
  * @param cls closure

+ * @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
  *        match all values that have the right key).
  * @param key maybe NULL (to match all entries)
  * @param vhash hash of the value, maybe NULL (to
  *        match all values that have the right key).


@@ -118,172 +99,134 @@ template_plugin_next_request (void *next_cls,
  *        there may be!
  * @param type entries of which type are relevant?
  *     Use 0 for any type.
  *        there may be!
  * @param type entries of which type are relevant?
  *     Use 0 for any type.

- * @param iter function to call on each matching value;
- *        will be called once with a NULL value at the end
- * @param iter_cls closure for iter
+ * @param proc function to call on each matching value;
+ *        will be called with NULL if nothing matches
+ * @param proc_cls closure for proc

  */
 static void
  */
 static void

-template_plugin_get (void *cls,
-                    const GNUNET_HashCode * key,
-                    const GNUNET_HashCode * vhash,
-                    enum GNUNET_BLOCK_Type type,
-                    PluginIterator iter, void *iter_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);
 }
 
 
 {
   GNUNET_break (0);
 }
 
 

-/**
- * Update the priority for a particular key in the datastore.  If
- * the expiration time in value is different than the time found in
- * the datastore, the higher value should be kept.  For the
- * anonymity level, the lower value is to be used.  The specified
- * 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 our "struct Plugin*"
- * @param uid unique identifier of the datum
- * @param delta by how much should the priority
- *     change?  If priority + delta < 0 the
- *     priority should be set to 0 (never go
- *     negative).
- * @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
- */
-static int
-template_plugin_update (void *cls,
-                       uint64_t uid,
-                       int delta, struct GNUNET_TIME_Absolute expire,
-                       char **msg)
-{
-  GNUNET_break (0);
-  *msg = GNUNET_strdup ("not implemented");
-  return GNUNET_SYSERR;
-}
-

 
 /**
 
 /**

- * Select a subset of the items in the datastore and call
- * the given iterator for each of them.
+ * Get a random item for replication.  Returns a single, not expired,
+ * random item from those with the highest replication counters.  The
+ * item's replication counter is decremented by one IF it was positive
+ * before.  Call 'proc' with all values ZERO or NULL if the datastore
+ * is empty.

  *
  *

- * @param cls our "struct Plugin*"
- * @param type entries of which type should be considered?
- *        Use 0 for any type.
- * @param iter function to call on each matching value;
- *        will be called once with a NULL value at the end
- * @param iter_cls closure for iter
+ * @param cls closure
+ * @param proc function to call the value (once only).
+ * @param proc_cls closure for proc

  */
 static void
  */
 static void

-template_plugin_iter_low_priority (void *cls,
-                                  enum GNUNET_BLOCK_Type type,
-                                  PluginIterator iter,
-                                  void *iter_cls)
+template_plugin_get_replication (void *cls, PluginDatumProcessor proc,
+                                 void *proc_cls)

 {
   GNUNET_break (0);
 }
 
 
 {
   GNUNET_break (0);
 }
 
 

-

 /**
 /**

- * Select a subset of the items in the datastore and call
- * the given iterator for each of them.
+ * Get a random item for expiration.  Call 'proc' with all values ZERO
+ * or NULL if the datastore is empty.

  *
  *

- * @param cls our "struct Plugin*"
- * @param type entries of which type should be considered?
- *        Use 0 for any type.
- * @param iter function to call on each matching value;
- *        will be called once with a NULL value at the end
- * @param iter_cls closure for iter
+ * @param cls closure
+ * @param proc function to call the value (once only).
+ * @param proc_cls closure for proc

  */
 static void
  */
 static void

-template_plugin_iter_zero_anonymity (void *cls,
-                                    enum GNUNET_BLOCK_Type type,
-                                    PluginIterator iter,
-                                    void *iter_cls)
+template_plugin_get_expiration (void *cls, PluginDatumProcessor proc,
+                                void *proc_cls)

 {
   GNUNET_break (0);
 }
 
 
 {
   GNUNET_break (0);
 }
 
 

-

 /**
 /**

- * Select a subset of the items in the datastore and call
- * the given iterator for each of them.
+ * Update the priority for a particular key in the datastore.  If
+ * the expiration time in value is different than the time found in
+ * the datastore, the higher value should be kept.  For the
+ * anonymity level, the lower value is to be used.  The specified
+ * 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 our "struct Plugin*"
  *
  * @param cls our "struct Plugin*"

- * @param type entries of which type should be considered?
- *        Use 0 for any type.
- * @param iter function to call on each matching value;
- *        will be called once with a NULL value at the end
- * @param iter_cls closure for iter
+ * @param uid unique identifier of the datum
+ * @param delta by how much should the priority
+ *     change?  If priority + delta < 0 the
+ *     priority should be set to 0 (never go
+ *     negative).
+ * @param expire new expiration time should be the
+ *     MAX of any existing expiration time and
+ *     this value
+ * @param cont continuation called with success or failure status
+ * @param cons_cls continuation closure

  */
 static void
  */
 static void

-template_plugin_iter_ascending_expiration (void *cls,
-                                          enum GNUNET_BLOCK_Type type,
-                                          PluginIterator iter,
-                                          void *iter_cls)
+template_plugin_update (void *cls, uint64_t uid, int delta,
+                        struct GNUNET_TIME_Absolute expire,
+                        PluginUpdateCont cont, void *cont_cls)

 {
   GNUNET_break (0);
 {
   GNUNET_break (0);

+  cont (cont_cls, GNUNET_SYSERR, "not implemented");

 }
 
 
 }
 
 

-

 /**
 /**

- * Select a subset of the items in the datastore and call
- * the given iterator for each of them.
+ * Call the given processor on an item with zero anonymity.

  *
  * @param cls our "struct Plugin*"
  *
  * @param cls our "struct Plugin*"

+ * @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.
  * @param type entries of which type should be considered?
  *        Use 0 for any type.

- * @param iter function to call on each matching value;
- *        will be called once with a NULL value at the end
- * @param iter_cls closure for iter
+ * @param proc function to call on each matching value;
+ *        will be called  with NULL if no value matches
+ * @param proc_cls closure for proc

  */
 static void
  */
 static void

-template_plugin_iter_migration_order (void *cls,
-                                     enum GNUNET_BLOCK_Type type,
-                                     PluginIterator iter,
-                                     void *iter_cls)
+template_plugin_get_zero_anonymity (void *cls, uint64_t offset,
+                                    enum GNUNET_BLOCK_Type type,
+                                    PluginDatumProcessor proc, void *proc_cls)

 {
   GNUNET_break (0);
 }
 
 
 {
   GNUNET_break (0);
 }
 
 

-

 /**
 /**

- * Select a subset of the items in the datastore and call
- * the given iterator for each of them.
- *
- * @param cls our "struct Plugin*"
- * @param type entries of which type should be considered?
- *        Use 0 for any type.
- * @param iter function to call on each matching value;
- *        will be called once with a NULL value at the end
- * @param iter_cls closure for iter
+ * Drop database.

  */
 static void
  */
 static void

-template_plugin_iter_all_now (void *cls,
-                             enum GNUNET_BLOCK_Type type,
-                             PluginIterator iter,
-                             void *iter_cls)
+template_plugin_drop (void *cls)

 {
   GNUNET_break (0);
 }
 
 
 /**
 {
   GNUNET_break (0);
 }
 
 
 /**

- * Drop database.
+ * 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_plugin_drop (void *cls)
+static void
+template_get_keys (void *cls,
+                  PluginKeyProcessor proc,
+                  void *proc_cls)

 {
 {

-  GNUNET_break (0);
+  proc (proc_cls, NULL, 0);

 }
 
 
 }
 
 


@@ -300,23 +243,21 @@ libgnunet_plugin_datastore_template_init (void *cls)
   struct GNUNET_DATASTORE_PluginFunctions *api;
   struct Plugin *plugin;
 
   struct GNUNET_DATASTORE_PluginFunctions *api;
   struct Plugin *plugin;
 

-  plugin = GNUNET_malloc (sizeof (struct Plugin));
+  plugin = GNUNET_new (struct Plugin);

   plugin->env = env;
   plugin->env = env;

-  api = GNUNET_malloc (sizeof (struct GNUNET_DATASTORE_PluginFunctions));
+  api = GNUNET_new (struct GNUNET_DATASTORE_PluginFunctions);

   api->cls = plugin;
   api->cls = plugin;

-  api->get_size = &template_plugin_get_size;
+  api->estimate_size = &template_plugin_estimate_size;

   api->put = &template_plugin_put;
   api->put = &template_plugin_put;

-  api->next_request = &template_plugin_next_request;
-  api->get = &template_plugin_get;

   api->update = &template_plugin_update;
   api->update = &template_plugin_update;

-  api->iter_low_priority = &template_plugin_iter_low_priority;
-  api->iter_zero_anonymity = &template_plugin_iter_zero_anonymity;
-  api->iter_ascending_expiration = &template_plugin_iter_ascending_expiration;
-  api->iter_migration_order = &template_plugin_iter_migration_order;
-  api->iter_all_now = &template_plugin_iter_all_now;
+  api->get_key = &template_plugin_get_key;
+  api->get_replication = &template_plugin_get_replication;
+  api->get_expiration = &template_plugin_get_expiration;
+  api->get_zero_anonymity = &template_plugin_get_zero_anonymity;

   api->drop = &template_plugin_drop;
   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;
 }
 
   return api;
 }