src/include/gnunet_block_plugin.h

   1 /*
   2      This file is part of GNUnet
   3      (C) 2010 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file include/gnunet_block_plugin.h
  23  * @brief API for block plugins.  Each block plugin must conform to
  24  *        the API specified by this header.
  25  * @author Christian Grothoff
  26  */
  27 #ifndef PLUGIN_BLOCK_H
  28 #define PLUGIN_BLOCK_H
  29
  30 #include "gnunet_util_lib.h"
  31 #include "gnunet_container_lib.h"
  32 #include "gnunet_block_lib.h"
  33
  34
  35 /**
  36  * Function called to validate a reply or a request.  For
  37  * request evaluation, simply pass "NULL" for the reply_block.
  38  * Note that it is assumed that the reply has already been
  39  * matched to the key (and signatures checked) as it would
  40  * be done with the "get_key" function.
  41  *
  42  * @param cls closure
  43  * @param type block type
  44  * @param query original query (hash)
  45  * @param bf pointer to bloom filter associated with query; possibly updated (!)
  46  * @param bf_mutator mutation value for bf
  47  * @param xquery extrended query data (can be NULL, depending on type)
  48  * @param xquery_size number of bytes in xquery
  49  * @param reply_block response to validate
  50  * @param reply_block_size number of bytes in reply block
  51  * @return characterization of result
  52  */
  53 typedef enum GNUNET_BLOCK_EvaluationResult
  54     (*GNUNET_BLOCK_EvaluationFunction) (void *cls,
  55                                         enum GNUNET_BLOCK_Type type,
  56                                         const GNUNET_HashCode * query,
  57                                         struct GNUNET_CONTAINER_BloomFilter **
  58                                         bf, int32_t bf_mutator,
  59                                         const void *xquery, size_t xquery_size,
  60                                         const void *reply_block,
  61                                         size_t reply_block_size);
  62
  63
  64 /**
  65  * Function called to obtain the key for a block.
  66  *
  67  * @param cls closure
  68  * @param type block type
  69  * @param block block to get the key for
  70  * @param block_size number of bytes in block
  71  * @param key set to the key (query) for the given block
  72  * @return GNUNET_YES on success,
  73  *         GNUNET_NO if the block is malformed
  74  *         GNUNET_SYSERR if type not supported
  75  *         (or if extracting a key from a block of this type does not work)
  76  */
  77 typedef int
  78     (*GNUNET_BLOCK_GetKeyFunction) (void *cls,
  79                                     enum GNUNET_BLOCK_Type type,
  80                                     const void *block,
  81                                     size_t block_size, GNUNET_HashCode * key);
  82
  83
  84
  85 /**
  86  * Each plugin is required to return a pointer to a struct of this
  87  * type as the return value from its entry point.
  88  */
  89 struct GNUNET_BLOCK_PluginFunctions
  90 {
  91
  92   /**
  93    * Closure for all of the callbacks.
  94    */
  95   void *cls;
  96
  97   /**
  98    * 0-terminated array of block types supported by this plugin.
  99    */
 100   const enum GNUNET_BLOCK_Type *types;
 101
 102   /**
 103    * Main function of a block plugin.  Allows us to check if a
 104    * block matches a query.
 105    */
 106   GNUNET_BLOCK_EvaluationFunction evaluate;
 107
 108   /**
 109    * Obtain the key for a given block (if possible).
 110    */
 111   GNUNET_BLOCK_GetKeyFunction get_key;
 112
 113 };
 114
 115
 116 #endif