de-experimentalizing
[oweals/gnunet.git] / src / datastore / plugin_datastore_template.c
index 4bfb452ed4ed317cae28ae26a4db97d419954b0d..40b191538ab2caf1ffe2cba282ee24212dbf3dc9 100644 (file)
@@ -4,7 +4,7 @@
 
      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
@@ -25,7 +25,7 @@
  */
 
 #include "platform.h"
-#include "plugin_datastore.h"
+#include "gnunet_datastore_plugin.h"
 
 
 /**
@@ -43,6 +43,8 @@ struct Plugin
 /**
  * Get an estimate of how much space the database is
  * currently using.
+ *
+ * @param cls our "struct Plugin*"
  * @return number of bytes used on disk
  */
 static unsigned long long template_plugin_get_size (void *cls)
@@ -62,18 +64,20 @@ 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 replication replication-level 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,
-                  uint32_t type,
-                  uint32_t priority,
-                  uint32_t anonymity,
+                    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)
 {
@@ -124,13 +128,48 @@ static void
 template_plugin_get (void *cls,
                     const GNUNET_HashCode * key,
                     const GNUNET_HashCode * vhash,
-                    uint32_t type,
+                    enum GNUNET_BLOCK_Type type,
                     PluginIterator iter, void *iter_cls)
 {
   GNUNET_break (0);
 }
 
 
+
+/**
+ * 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 'iter' with all values ZERO or NULL if the datastore is empty.
+ *
+ * @param cls closure
+ * @param iter function to call the value (once only).
+ * @param iter_cls closure for iter
+ */
+static void
+template_plugin_replication_get (void *cls,
+                                PluginIterator iter, void *iter_cls)
+{
+  GNUNET_break (0);
+}
+
+
+/**
+ * Get a random item for expiration.
+ * Call 'iter' with all values ZERO or NULL if the datastore is empty.
+ *
+ * @param cls closure
+ * @param iter function to call the value (once only).
+ * @param iter_cls closure for iter
+ */
+static void
+template_plugin_expiration_get (void *cls,
+                               PluginIterator iter, void *iter_cls)
+{
+  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
@@ -142,6 +181,7 @@ template_plugin_get (void *cls,
  * 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
@@ -169,27 +209,7 @@ template_plugin_update (void *cls,
  * Select a subset of the items in the datastore and call
  * the given iterator for each of them.
  *
- * @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
- */
-static void
-template_plugin_iter_low_priority (void *cls,
-                                  uint32_t type,
-                                  PluginIterator iter,
-                                  void *iter_cls)
-{
-  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;
@@ -198,72 +218,9 @@ template_plugin_iter_low_priority (void *cls,
  */
 static void
 template_plugin_iter_zero_anonymity (void *cls,
-                       uint32_t type,
-                       PluginIterator iter,
-                       void *iter_cls)
-{
-  GNUNET_break (0);
-}
-
-
-
-/**
- * Select a subset of the items in the datastore and call
- * the given iterator for each of them.
- *
- * @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
- */
-static void
-template_plugin_iter_ascending_expiration (void *cls,
-                       uint32_t type,
-                       PluginIterator iter,
-                       void *iter_cls)
-{
-  GNUNET_break (0);
-}
-
-
-
-/**
- * Select a subset of the items in the datastore and call
- * the given iterator for each of them.
- *
- * @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
- */
-static void
-template_plugin_iter_migration_order (void *cls,
-                       uint32_t type,
-                       PluginIterator iter,
-                       void *iter_cls)
-{
-  GNUNET_break (0);
-}
-
-
-
-/**
- * Select a subset of the items in the datastore and call
- * the given iterator for each of them.
- *
- * @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
- */
-static void
-template_plugin_iter_all_now (void *cls,
-                       uint32_t type,
-                       PluginIterator iter,
-                       void *iter_cls)
+                                    enum GNUNET_BLOCK_Type type,
+                                    PluginIterator iter,
+                                    void *iter_cls)
 {
   GNUNET_break (0);
 }
@@ -281,6 +238,9 @@ template_plugin_drop (void *cls)
 
 /**
  * Entry point for the plugin.
+ *
+ * @param cls the "struct GNUNET_DATASTORE_PluginEnvironment*"
+ * @return our "struct Plugin*"
  */
 void *
 libgnunet_plugin_datastore_template_init (void *cls)
@@ -297,12 +257,10 @@ libgnunet_plugin_datastore_template_init (void *cls)
   api->put = &template_plugin_put;
   api->next_request = &template_plugin_next_request;
   api->get = &template_plugin_get;
+  api->replication_get = &template_plugin_replication_get;
+  api->expiration_get = &template_plugin_expiration_get;
   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->drop = &template_plugin_drop;
   GNUNET_log_from (GNUNET_ERROR_TYPE_INFO,
                    "template", _("Template database running\n"));
@@ -312,6 +270,8 @@ libgnunet_plugin_datastore_template_init (void *cls)
 
 /**
  * Exit point from the plugin.
+ * @param cls our "struct Plugin*"
+ * @return always NULL
  */
 void *
 libgnunet_plugin_datastore_template_done (void *cls)