diff options
author | Christian Grothoff <christian@grothoff.org> | 2010-09-12 13:08:54 +0000 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2010-09-12 13:08:54 +0000 |
commit | a42b4e0ed22b65631caea4bb456f3d8fc21f11b1 (patch) | |
tree | a3a1e30a7f8e7f8b30c75c96923249831a7e8b2e /src/block/plugin_block_template.c | |
parent | dd253b7f7591f0869f8ea14ee111b7d3b3e480b6 (diff) | |
download | gnunet-a42b4e0ed22b65631caea4bb456f3d8fc21f11b1.tar.gz gnunet-a42b4e0ed22b65631caea4bb456f3d8fc21f11b1.zip |
towards pluggable block library
Diffstat (limited to 'src/block/plugin_block_template.c')
-rw-r--r-- | src/block/plugin_block_template.c | 118 |
1 files changed, 118 insertions, 0 deletions
diff --git a/src/block/plugin_block_template.c b/src/block/plugin_block_template.c new file mode 100644 index 000000000..016a3fc8f --- /dev/null +++ b/src/block/plugin_block_template.c | |||
@@ -0,0 +1,118 @@ | |||
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 block/plugin_block_template.c | ||
23 | * @brief template for a block plugin | ||
24 | * @author Christian Grothoff | ||
25 | */ | ||
26 | |||
27 | #include "platform.h" | ||
28 | #include "plugin_block.h" | ||
29 | |||
30 | #define DEBUG_TEMPLATE GNUNET_NO | ||
31 | |||
32 | |||
33 | /** | ||
34 | * Function called to validate a reply or a request. For | ||
35 | * request evaluation, simply pass "NULL" for the reply_block. | ||
36 | * | ||
37 | * @param cls closure | ||
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 | ||
47 | */ | ||
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, | ||
53 | int32_t bf_mutator, | ||
54 | const void *xquery, | ||
55 | size_t xquery_size, | ||
56 | const void *reply_block, | ||
57 | size_t reply_block_size) | ||
58 | { | ||
59 | return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED; | ||
60 | } | ||
61 | |||
62 | |||
63 | /** | ||
64 | * Function called to obtain the key for a block. | ||
65 | * | ||
66 | * @param cls closure | ||
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) | ||
73 | */ | ||
74 | static int | ||
75 | block_plugin_template_get_key (void *cls, | ||
76 | enum GNUNET_BLOCK_Type type, | ||
77 | const void *block, | ||
78 | size_t block_size, | ||
79 | GNUNET_HashCode *key) | ||
80 | { | ||
81 | return GNUNET_SYSERR; | ||
82 | } | ||
83 | |||
84 | |||
85 | /** | ||
86 | * Entry point for the plugin. | ||
87 | */ | ||
88 | void * | ||
89 | gnunet_plugin_block_template_init (void *cls) | ||
90 | { | ||
91 | static enum GNUNET_BLOCK_Type types[] = | ||
92 | { | ||
93 | /* FIXME: insert supported block types here */ | ||
94 | GNUNET_BLOCK_TYPE_ANY /* end of list */ | ||
95 | }; | ||
96 | struct GNUNET_BLOCK_PluginFunctions *api; | ||
97 | |||
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; | ||
101 | api->types = types; | ||
102 | return api; | ||
103 | } | ||
104 | |||
105 | |||
106 | /** | ||
107 | * Exit point from the plugin. | ||
108 | */ | ||
109 | void * | ||
110 | gnunet_plugin_block_template_done (void *cls) | ||
111 | { | ||
112 | struct GNUNET_TRANSPORT_PluginFunctions *api = cls; | ||
113 | |||
114 | GNUNET_free (api); | ||
115 | return NULL; | ||
116 | } | ||
117 | |||
118 | /* end of plugin_block_template.c */ | ||