towards pluggable block library

1 files changed, 125 insertions, 0 deletions

diff --git a/src/include/gnunet_block_lib.h b/src/include/gnunet_block_lib.h
index 0bd9848d7..ace4f23bb 100644
--- a/src/include/gnunet_block_lib.h
+++ b/src/include/gnunet_block_lib.h
@@ -35,6 +35,7 @@ extern "C"
 #endif
 #endif
 
+
 /**
  * Blocks in the datastore and the datacache must have a unique type.
  */
@@ -82,6 +83,8 @@ enum GNUNET_BLOCK_Type
   };
 
 
+/* **************** FIXME: move these to block_fs.h or so ***************** */
+
 /**
  * @brief keyword block (advertising data under a keyword)
  */
@@ -216,6 +219,8 @@ struct OnDemandBlock
 };
 
 
+/* **************** OLD API ***************** */
+
 /**
  * Check if the given block is well-formed (and of the given type).
  *
@@ -234,6 +239,126 @@ GNUNET_BLOCK_check_block (enum GNUNET_BLOCK_Type type,
                           GNUNET_HashCode *query);
 
 
+/* **************** NEW API ***************** */
+
+/**
+ * Possible ways for how a block may relate to a query.
+ */
+enum GNUNET_BLOCK_EvaluationResult
+  {
+    /**
+     * Valid result, and there may be more.
+     */
+    GNUNET_BLOCK_EVALUATION_OK_MORE = 0,
+
+    /**
+     * Last possible valid result.
+     */
+    GNUNET_BLOCK_EVALUATION_OK_LAST = 1,
+
+    /**
+     * Valid result, but suppressed because it is a duplicate.
+     */
+    GNUNET_BLOCK_EVALUATION_OK_DUPLICATE = 2,
+
+    /**
+     * Block does not match query (invalid result)
+     */
+    GNUNET_BLOCK_EVALUATION_RESULT_INVALID = 3,
+
+    /**
+     * Query is valid, no reply given.
+     */
+    GNUNET_BLOCK_EVALUATION_REQUEST_VALID = 4,
+
+    /**
+     * Query format does not match block type (invalid query).  For
+     * example, xquery not given or xquery_size not appropriate for
+     * type.
+     */
+    GNUNET_BLOCK_EVALUATION_REQUEST_INVALID = 5,
+
+    /**
+     * Specified block type not supported by this plugin.
+     */
+    GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED = 6
+  };
+
+
+/**
+ * Handle to an initialized block library.
+ */
+struct GNUNET_BLOCK_Context;
+
+
+/**
+ * Create a block context.  Loads the block plugins.
+ *
+ * @param cfg configuration to use
+ * @return NULL on error
+ */
+struct GNUNET_BLOCK_Context *
+GNUNET_BLOCK_context_create (const struct GNUNET_CONFIGURATION_Handle *cfg);
+
+
+/**
+ * Destroy the block context.
+ *
+ * @param ctx context to destroy
+ */
+void
+GNUNET_BLOCK_context_destroy (struct GNUNET_BLOCK_Context *ctx);
+
+
+/**
+ * Function called to validate a reply or a request.  For
+ * request evaluation, simply pass "NULL" for the reply_block.
+ * Note that it is assumed that the reply has already been 
+ * matched to the key (and signatures checked) as it would
+ * be done with the "get_key" function.
+ *
+ * @param ctx block contxt
+ * @param type block type
+ * @param query original query (hash)
+ * @param bf pointer to bloom filter associated with query; possibly updated (!)
+ * @param bf_mutator mutation value for bf
+ * @param xquery extrended query data (can be NULL, depending on type)
+ * @param xquery_size number of bytes in xquery
+ * @param reply_block response to validate
+ * @param reply_block_size number of bytes in reply block
+ * @return characterization of result
+ */
+enum GNUNET_BLOCK_EvaluationResult
+GNUNET_BLOCK_evaluate (struct GNUNET_BLOCK_Context *ctx,
+                       enum GNUNET_BLOCK_Type type,
+                       const GNUNET_HashCode *query,
+                       struct GNUNET_CONTAINER_BloomFilter **bf,
+                       int32_t bf_mutator,
+                       const void *xquery,
+                       size_t xquery_size,
+                       const void *reply_block,
+                       size_t reply_block_size);
+
+
+/**
+ * Function called to obtain the key for a block.
+ *
+ * @param ctx block context
+ * @param type block type
+ * @param block block to get the key for
+ * @param block_size number of bytes in block
+ * @param key set to the key (query) for the given block
+ * @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)
+ */
+int
+GNUNET_BLOCK_get_key (struct GNUNET_BLOCK_Context *ctx,
+                      enum GNUNET_BLOCK_Type type,
+                      const void *block,
+                      size_t block_size,
+                      GNUNET_HashCode *key);
+
+
 #if 0                           /* keep Emacsens' auto-indent happy */
 {
 #endif