aboutsummaryrefslogtreecommitdiff
path: root/src/include/gnunet_block_lib.h
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2013-09-23 08:29:18 +0000
committerChristian Grothoff <christian@grothoff.org>2013-09-23 08:29:18 +0000
commitc6e5a96f679fe6e35e29792e4992fa337a3b69b5 (patch)
tree6545980d1373ba9c59e2dbcb9547dde22fd11881 /src/include/gnunet_block_lib.h
parent3b1601c14f00f204e26706799ff85ed8bc132569 (diff)
downloadgnunet-c6e5a96f679fe6e35e29792e4992fa337a3b69b5.tar.gz
gnunet-c6e5a96f679fe6e35e29792e4992fa337a3b69b5.zip
-doxygen
Diffstat (limited to 'src/include/gnunet_block_lib.h')
-rw-r--r--src/include/gnunet_block_lib.h76
1 files changed, 38 insertions, 38 deletions
diff --git a/src/include/gnunet_block_lib.h b/src/include/gnunet_block_lib.h
index 95b499f13..38ad78686 100644
--- a/src/include/gnunet_block_lib.h
+++ b/src/include/gnunet_block_lib.h
@@ -52,9 +52,9 @@ enum GNUNET_BLOCK_Type
52 */ 52 */
53 GNUNET_BLOCK_TYPE_FS_DBLOCK = 1, 53 GNUNET_BLOCK_TYPE_FS_DBLOCK = 1,
54 54
55 /** 55 /**
56 * Inner block in the CHK tree. 56 * Inner block in the CHK tree.
57 */ 57 */
58 GNUNET_BLOCK_TYPE_FS_IBLOCK = 2, 58 GNUNET_BLOCK_TYPE_FS_IBLOCK = 2,
59 59
60 /** 60 /**
@@ -128,46 +128,46 @@ enum GNUNET_BLOCK_Type
128 */ 128 */
129enum GNUNET_BLOCK_EvaluationResult 129enum GNUNET_BLOCK_EvaluationResult
130{ 130{
131 /** 131 /**
132 * Valid result, and there may be more. 132 * Valid result, and there may be more.
133 */ 133 */
134 GNUNET_BLOCK_EVALUATION_OK_MORE = 0, 134 GNUNET_BLOCK_EVALUATION_OK_MORE = 0,
135 135
136 /** 136 /**
137 * Last possible valid result. 137 * Last possible valid result.
138 */ 138 */
139 GNUNET_BLOCK_EVALUATION_OK_LAST = 1, 139 GNUNET_BLOCK_EVALUATION_OK_LAST = 1,
140 140
141 /** 141 /**
142 * Valid result, but suppressed because it is a duplicate. 142 * Valid result, but suppressed because it is a duplicate.
143 */ 143 */
144 GNUNET_BLOCK_EVALUATION_OK_DUPLICATE = 2, 144 GNUNET_BLOCK_EVALUATION_OK_DUPLICATE = 2,
145 145
146 /** 146 /**
147 * Block does not match query (invalid result) 147 * Block does not match query (invalid result)
148 */ 148 */
149 GNUNET_BLOCK_EVALUATION_RESULT_INVALID = 3, 149 GNUNET_BLOCK_EVALUATION_RESULT_INVALID = 3,
150 150
151 /** 151 /**
152 * Block does not match xquery (valid result, not relevant for the request) 152 * Block does not match xquery (valid result, not relevant for the request)
153 */ 153 */
154 GNUNET_BLOCK_EVALUATION_RESULT_IRRELEVANT = 4, 154 GNUNET_BLOCK_EVALUATION_RESULT_IRRELEVANT = 4,
155 155
156 /** 156 /**
157 * Query is valid, no reply given. 157 * Query is valid, no reply given.
158 */ 158 */
159 GNUNET_BLOCK_EVALUATION_REQUEST_VALID = 10, 159 GNUNET_BLOCK_EVALUATION_REQUEST_VALID = 10,
160 160
161 /** 161 /**
162 * Query format does not match block type (invalid query). For 162 * Query format does not match block type (invalid query). For
163 * example, xquery not given or xquery_size not appropriate for 163 * example, xquery not given or xquery_size not appropriate for
164 * type. 164 * type.
165 */ 165 */
166 GNUNET_BLOCK_EVALUATION_REQUEST_INVALID = 11, 166 GNUNET_BLOCK_EVALUATION_REQUEST_INVALID = 11,
167 167
168 /** 168 /**
169 * Specified block type not supported by this plugin. 169 * Specified block type not supported by this plugin.
170 */ 170 */
171 GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED = 20 171 GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED = 20
172}; 172};
173 173
@@ -220,11 +220,11 @@ GNUNET_BLOCK_context_destroy (struct GNUNET_BLOCK_Context *ctx);
220 * @param type block type 220 * @param type block type
221 * @param query original query (hash) 221 * @param query original query (hash)
222 * @param bf pointer to bloom filter associated with query; possibly updated (!) 222 * @param bf pointer to bloom filter associated with query; possibly updated (!)
223 * @param bf_mutator mutation value for bf 223 * @param bf_mutator mutation value for @a bf
224 * @param xquery extrended query data (can be NULL, depending on type) 224 * @param xquery extrended query data (can be NULL, depending on type)
225 * @param xquery_size number of bytes in xquery 225 * @param xquery_size number of bytes in @a xquery
226 * @param reply_block response to validate 226 * @param reply_block response to validate
227 * @param reply_block_size number of bytes in reply block 227 * @param reply_block_size number of bytes in @a reply_block
228 * @return characterization of result 228 * @return characterization of result
229 */ 229 */
230enum GNUNET_BLOCK_EvaluationResult 230enum GNUNET_BLOCK_EvaluationResult
@@ -243,11 +243,11 @@ GNUNET_BLOCK_evaluate (struct GNUNET_BLOCK_Context *ctx,
243 * @param ctx block context 243 * @param ctx block context
244 * @param type block type 244 * @param type block type
245 * @param block block to get the key for 245 * @param block block to get the key for
246 * @param block_size number of bytes in block 246 * @param block_size number of bytes in @a block
247 * @param key set to the key (query) for the given block 247 * @param key set to the key (query) for the given block
248 * @return GNUNET_YES on success, 248 * @return #GNUNET_YES on success,
249 * GNUNET_NO if the block is malformed 249 * #GNUNET_NO if the block is malformed
250 * GNUNET_SYSERR if type not supported 250 * #GNUNET_SYSERR if type not supported
251 * (or if extracting a key from a block of this type does not work) 251 * (or if extracting a key from a block of this type does not work)
252 */ 252 */
253int 253int
@@ -263,7 +263,7 @@ GNUNET_BLOCK_get_key (struct GNUNET_BLOCK_Context *ctx,
263 * 263 *
264 * @param bf_mutator mutation value to use 264 * @param bf_mutator mutation value to use
265 * @param seen_results results already seen 265 * @param seen_results results already seen
266 * @param seen_results_count number of entries in 'seen_results' 266 * @param seen_results_count number of entries in @a seen_results
267 * @return NULL if seen_results_count is 0, otherwise a BF 267 * @return NULL if seen_results_count is 0, otherwise a BF
268 * that would match the given results. 268 * that would match the given results.
269 */ 269 */