1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
/*
This file is part of GNUnet
(C) 2010 Christian Grothoff (and other contributing authors)
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
by the Free Software Foundation; either version 3, or (at your
option) any later version.
GNUnet is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
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.
*/
/**
* @file block/plugin_block_template.c
* @brief template for a block plugin
* @author Christian Grothoff
*/
#include "platform.h"
#include "gnunet_block_plugin.h"
#define DEBUG_TEMPLATE GNUNET_NO
/**
* Function called to validate a reply or a request. For
* request evaluation, simply pass "NULL" for the reply_block.
*
* @param cls closure
* @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
*/
static enum GNUNET_BLOCK_EvaluationResult
block_plugin_template_evaluate (void *cls,
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)
{
return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
}
/**
* Function called to obtain the key for a block.
*
* @param cls closure
* @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)
*/
static int
block_plugin_template_get_key (void *cls,
enum GNUNET_BLOCK_Type type,
const void *block,
size_t block_size, GNUNET_HashCode * key)
{
return GNUNET_SYSERR;
}
/**
* Entry point for the plugin.
*/
void *
libgnunet_plugin_block_template_init (void *cls)
{
static enum GNUNET_BLOCK_Type types[] =
{
/* FIXME: insert supported block types here */
GNUNET_BLOCK_TYPE_ANY /* end of list */
};
struct GNUNET_BLOCK_PluginFunctions *api;
api = GNUNET_malloc (sizeof (struct GNUNET_BLOCK_PluginFunctions));
api->evaluate = &block_plugin_template_evaluate;
api->get_key = &block_plugin_template_get_key;
api->types = types;
return api;
}
/**
* Exit point from the plugin.
*/
void *
libgnunet_plugin_block_template_done (void *cls)
{
struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
GNUNET_free (api);
return NULL;
}
/* end of plugin_block_template.c */
|
