2 This file is part of GNUnet
3 Copyright (C) 2010 GNUnet e.V.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, 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_EXTRA_LOGGING
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 eo control flags
40 * @param query original query (hash)
41 * @param bf pointer to bloom filter associated with query; possibly updated (!)
42 * @param bf_mutator mutation value for bf
43 * @param xquery extrended query data (can be NULL, depending on type)
44 * @param xquery_size number of bytes in xquery
45 * @param reply_block response to validate
46 * @param reply_block_size number of bytes in reply block
47 * @return characterization of result
49 static enum GNUNET_BLOCK_EvaluationResult
50 block_plugin_template_evaluate (void *cls,
51 enum GNUNET_BLOCK_Type type,
52 enum GNUNET_BLOCK_EvaluationOptions eo,
53 const struct GNUNET_HashCode *query,
54 struct GNUNET_CONTAINER_BloomFilter **bf,
58 const void *reply_block,
59 size_t reply_block_size)
61 struct GNUNET_HashCode chash;
62 struct GNUNET_HashCode mhash;
63 /* FIXME: check validity first... */
65 /* mandatory duplicate-detection code... */
68 GNUNET_CRYPTO_hash (reply_block, reply_block_size, &chash);
69 GNUNET_BLOCK_mingle_hash (&chash, bf_mutator, &mhash);
72 if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (*bf, &mhash))
73 return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
77 *bf = GNUNET_CONTAINER_bloomfilter_init (NULL, 8, 64 /* BLOOMFILTER_K */);
79 GNUNET_CONTAINER_bloomfilter_add (*bf, &mhash);
81 /* FIXME: other stuff here... */
82 return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
87 * Function called to obtain the key for a block.
90 * @param type block type
91 * @param block block to get the key for
92 * @param block_size number of bytes in block
93 * @param key set to the key (query) for the given block
94 * @return GNUNET_OK on success, GNUNET_SYSERR if type not supported
95 * (or if extracting a key from a block of this type does not work)
98 block_plugin_template_get_key (void *cls, enum GNUNET_BLOCK_Type type,
99 const void *block, size_t block_size,
100 struct GNUNET_HashCode * key)
102 return GNUNET_SYSERR;
107 * Entry point for the plugin.
110 libgnunet_plugin_block_template_init (void *cls)
112 static enum GNUNET_BLOCK_Type types[] =
114 /* FIXME: insert supported block types here */
115 GNUNET_BLOCK_TYPE_ANY /* end of list */
117 struct GNUNET_BLOCK_PluginFunctions *api;
119 api = GNUNET_new (struct GNUNET_BLOCK_PluginFunctions);
120 api->evaluate = &block_plugin_template_evaluate;
121 api->get_key = &block_plugin_template_get_key;
128 * Exit point from the plugin.
131 libgnunet_plugin_block_template_done (void *cls)
133 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
139 /* end of plugin_block_template.c */