2 This file is part of GNUnet
3 (C) 2010 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @file block/plugin_block_template.c
23 * @brief template for a block plugin
24 * @author Christian Grothoff
28 #include "gnunet_block_plugin.h"
30 #define DEBUG_TEMPLATE GNUNET_NO
34 * Function called to validate a reply or a request. For
35 * request evaluation, simply pass "NULL" for the reply_block.
38 * @param type block type
39 * @param query original query (hash)
40 * @param bf pointer to bloom filter associated with query; possibly updated (!)
41 * @param bf_mutator mutation value for bf
42 * @param xquery extrended query data (can be NULL, depending on type)
43 * @param xquery_size number of bytes in xquery
44 * @param reply_block response to validate
45 * @param reply_block_size number of bytes in reply block
46 * @return characterization of result
48 static enum GNUNET_BLOCK_EvaluationResult
49 block_plugin_template_evaluate (void *cls,
50 enum GNUNET_BLOCK_Type type,
51 const GNUNET_HashCode *query,
52 struct GNUNET_CONTAINER_BloomFilter **bf,
56 const void *reply_block,
57 size_t reply_block_size)
59 return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
64 * Function called to obtain the key for a block.
67 * @param type block type
68 * @param block block to get the key for
69 * @param block_size number of bytes in block
70 * @param key set to the key (query) for the given block
71 * @return GNUNET_OK on success, GNUNET_SYSERR if type not supported
72 * (or if extracting a key from a block of this type does not work)
75 block_plugin_template_get_key (void *cls,
76 enum GNUNET_BLOCK_Type type,
86 * Entry point for the plugin.
89 libgnunet_plugin_block_template_init (void *cls)
91 static enum GNUNET_BLOCK_Type types[] =
93 /* FIXME: insert supported block types here */
94 GNUNET_BLOCK_TYPE_ANY /* end of list */
96 struct GNUNET_BLOCK_PluginFunctions *api;
98 api = GNUNET_malloc (sizeof (struct GNUNET_BLOCK_PluginFunctions));
99 api->evaluate = &block_plugin_template_evaluate;
100 api->get_key = &block_plugin_template_get_key;
107 * Exit point from the plugin.
110 libgnunet_plugin_block_template_done (void *cls)
112 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
118 /* end of plugin_block_template.c */