spell out message types more, use correct conversion direction

[oweals/gnunet.git] / src / block / plugin_block_test.c

diff --git a/src/block/plugin_block_test.c b/src/block/plugin_block_test.c
index e6b4f496007885934c7178b3a80da769a0ac150d..b692d6230efe0de4d33178d39cb2895c335a8c3b 100644 (file)
--- a/src/block/plugin_block_test.c
+++ b/src/block/plugin_block_test.c
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet
-     (C) 2010 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2010 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.
 */
 
 /**
@@ -28,8 +28,6 @@
 #include "platform.h"
 #include "gnunet_block_plugin.h"
 
-#define DEBUG_TEST GNUNET_EXTRA_LOGGING
-
 
 /**
  * Number of bits we set per entry in the bloomfilter.
@@ -43,29 +41,34 @@
  *
  * @param cls closure
  * @param type block type
+ * @param eo control flags
  * @param query original query (hash)
  * @param bf pointer to bloom filter associated with query; possibly updated (!)
- * @param bf_mutator mutation value for bf
+ * @param bf_mutator mutation value for @a bf
  * @param xquery extrended query data (can be NULL, depending on type)
- * @param xquery_size number of bytes in xquery
+ * @param xquery_size number of bytes in @a xquery
  * @param reply_block response to validate
- * @param reply_block_size number of bytes in reply block
+ * @param reply_block_size number of bytes in @a reply_block
  * @return characterization of result
  */
 static enum GNUNET_BLOCK_EvaluationResult
-block_plugin_test_evaluate (void *cls, enum GNUNET_BLOCK_Type type,
-                            const struct GNUNET_HashCode * query,
+block_plugin_test_evaluate (void *cls,
+                            enum GNUNET_BLOCK_Type type,
+                            enum GNUNET_BLOCK_EvaluationOptions eo,
+                            const struct GNUNET_HashCode *query,
                             struct GNUNET_CONTAINER_BloomFilter **bf,
-                            int32_t bf_mutator, const void *xquery,
-                            size_t xquery_size, const void *reply_block,
+                            int32_t bf_mutator,
+                            const void *xquery,
+                            size_t xquery_size,
+                            const void *reply_block,
                             size_t reply_block_size)
 {
   struct GNUNET_HashCode chash;
   struct GNUNET_HashCode mhash;
 
-  if (type != GNUNET_BLOCK_TYPE_TEST)
+  if ( GNUNET_BLOCK_TYPE_TEST != type)
     return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
-  if (xquery_size != 0)
+  if (0 != xquery_size)
   {
     GNUNET_break_op (0);
     return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
@@ -98,9 +101,9 @@ block_plugin_test_evaluate (void *cls, enum GNUNET_BLOCK_Type type,
  * @param cls closure
  * @param type block type
  * @param block block to get the key for
- * @param block_size number of bytes in block
+ * @param block_size number of bytes in @a block
  * @param key set to the key (query) for the given block
- * @return GNUNET_OK on success, GNUNET_SYSERR if type not supported
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR if type not supported
  *         (or if extracting a key from a block of this type does not work)
  */
 static int
@@ -116,6 +119,9 @@ block_plugin_test_get_key (void *cls, enum GNUNET_BLOCK_Type type,
 
 /**
  * Entry point for the plugin.
+ *
+ * @param cls NULL
+ * @return the exported block API
  */
 void *
 libgnunet_plugin_block_test_init (void *cls)
@@ -127,7 +133,7 @@ libgnunet_plugin_block_test_init (void *cls)
   };
   struct GNUNET_BLOCK_PluginFunctions *api;
 
-  api = GNUNET_malloc (sizeof (struct GNUNET_BLOCK_PluginFunctions));
+  api = GNUNET_new (struct GNUNET_BLOCK_PluginFunctions);
   api->evaluate = &block_plugin_test_evaluate;
   api->get_key = &block_plugin_test_get_key;
   api->types = types;
@@ -137,11 +143,14 @@ libgnunet_plugin_block_test_init (void *cls)
 
 /**
  * Exit point from the plugin.
+ *
+ * @param cls the return value from #libgnunet_plugin_block_test_init
+ * @return NULL
  */
 void *
 libgnunet_plugin_block_test_done (void *cls)
 {
-  struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
+  struct GNUNET_BLOCK_PluginFunctions *api = cls;
 
   GNUNET_free (api);
   return NULL;