/*
This file is part of GNUnet.
- (C) 2010 Christian Grothoff (and other contributing authors)
+ Copyright (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
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.
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
*/
/**
*/
enum GNUNET_BLOCK_Type
{
- /**
- * Any type of block, used as a wildcard when searching. Should
- * never be attached to a specific block.
- */
+ /**
+ * Any type of block, used as a wildcard when searching. Should
+ * never be attached to a specific block.
+ */
GNUNET_BLOCK_TYPE_ANY = 0,
- /**
- * Data block (leaf) in the CHK tree.
- */
+ /**
+ * Data block (leaf) in the CHK tree.
+ */
GNUNET_BLOCK_TYPE_FS_DBLOCK = 1,
- /**
- * Inner block in the CHK tree.
- */
+ /**
+ * Inner block in the CHK tree.
+ */
GNUNET_BLOCK_TYPE_FS_IBLOCK = 2,
- /**
- * Type of a block representing a keyword search result. Note that
- * the values for KBLOCK, SBLOCK and NBLOCK must be consecutive.
- */
+ /**
+ * Legacy type, no longer in use.
+ */
GNUNET_BLOCK_TYPE_FS_KBLOCK = 3,
- /**
- * Type of a block that is used to advertise content in a namespace.
- */
+ /**
+ * Legacy type, no longer in use.
+ */
GNUNET_BLOCK_TYPE_FS_SBLOCK = 4,
- /**
- * Type of a block that is used to advertise a namespace.
- */
+ /**
+ * Legacy type, no longer in use.
+ */
GNUNET_BLOCK_TYPE_FS_NBLOCK = 5,
- /**
- * Type of a block representing a block to be encoded on demand from disk.
- * Should never appear on the network directly.
- */
+ /**
+ * Type of a block representing a block to be encoded on demand from disk.
+ * Should never appear on the network directly.
+ */
GNUNET_BLOCK_TYPE_FS_ONDEMAND = 6,
- /**
- * Type of a block that contains a HELLO for a peer (for
- * DHT find-peer operations).
- */
+ /**
+ * Type of a block that contains a HELLO for a peer (for
+ * DHT and CADET find-peer operations).
+ */
GNUNET_BLOCK_TYPE_DHT_HELLO = 7,
- /**
- * Block for testing.
- */
+ /**
+ * Block for testing.
+ */
GNUNET_BLOCK_TYPE_TEST = 8,
- /**
- * Block for storing .gnunet-domains
- */
+ /**
+ * Type of a block representing any type of search result
+ * (universal). Implemented in the context of #2564, replaces
+ * SBLOCKS, KBLOCKS and NBLOCKS.
+ */
+ GNUNET_BLOCK_TYPE_FS_UBLOCK = 9,
+
+ /**
+ * Block for storing DNS exit service advertisements.
+ */
GNUNET_BLOCK_TYPE_DNS = 10,
- /**
- * Block for storing record data
- */
+ /**
+ * Block for storing record data
+ */
GNUNET_BLOCK_TYPE_GNS_NAMERECORD = 11,
- /**
- * Block for storing mesh peers
- */
- GNUNET_BLOCK_TYPE_MESH_PEER = 20,
+ /**
+ * Block to store a cadet regex state
+ */
+ GNUNET_BLOCK_TYPE_REGEX = 22,
+
+ /**
+ * Block to store a cadet regex accepting state
+ */
+ GNUNET_BLOCK_TYPE_REGEX_ACCEPT = 23
+};
+
+
+/**
+ * Flags that can be set to control the evaluation.
+ */
+enum GNUNET_BLOCK_EvaluationOptions
+{
+
+ /**
+ * Default behavior.
+ */
+ GNUNET_BLOCK_EO_NONE = 0,
- /**
- * Block for finding peers by type
- */
- GNUNET_BLOCK_TYPE_MESH_PEER_BY_TYPE = 21
+ /**
+ * The block is obtained from the local database, skip cryptographic
+ * checks.
+ */
+ GNUNET_BLOCK_EO_LOCAL_SKIP_CRYPTO = 1
};
*/
enum GNUNET_BLOCK_EvaluationResult
{
- /**
- * Valid result, and there may be more.
- */
+ /**
+ * Valid result, and there may be more.
+ */
GNUNET_BLOCK_EVALUATION_OK_MORE = 0,
- /**
- * Last possible valid result.
- */
+ /**
+ * Last possible valid result.
+ */
GNUNET_BLOCK_EVALUATION_OK_LAST = 1,
- /**
- * Valid result, but suppressed because it is a duplicate.
- */
+ /**
+ * Valid result, but suppressed because it is a duplicate.
+ */
GNUNET_BLOCK_EVALUATION_OK_DUPLICATE = 2,
- /**
- * Block does not match query (invalid result)
- */
+ /**
+ * Block does not match query (invalid result)
+ */
GNUNET_BLOCK_EVALUATION_RESULT_INVALID = 3,
- /**
- * Query is valid, no reply given.
- */
- GNUNET_BLOCK_EVALUATION_REQUEST_VALID = 4,
-
- /**
- * Query format does not match block type (invalid query). For
- * example, xquery not given or xquery_size not appropriate for
- * type.
- */
- GNUNET_BLOCK_EVALUATION_REQUEST_INVALID = 5,
-
- /**
- * Specified block type not supported by this plugin.
- */
- GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED = 6
+ /**
+ * Block does not match xquery (valid result, not relevant for the request)
+ */
+ GNUNET_BLOCK_EVALUATION_RESULT_IRRELEVANT = 4,
+
+ /**
+ * Query is valid, no reply given.
+ */
+ GNUNET_BLOCK_EVALUATION_REQUEST_VALID = 10,
+
+ /**
+ * Query format does not match block type (invalid query). For
+ * example, xquery not given or xquery_size not appropriate for
+ * type.
+ */
+ GNUNET_BLOCK_EVALUATION_REQUEST_INVALID = 11,
+
+ /**
+ * Specified block type not supported by this plugin.
+ */
+ GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED = 20
};
* @param hc where to store the result.
*/
void
-GNUNET_BLOCK_mingle_hash (const struct GNUNET_HashCode * in, uint32_t mingle_number,
- struct GNUNET_HashCode * hc);
+GNUNET_BLOCK_mingle_hash (const struct GNUNET_HashCode *in,
+ uint32_t mingle_number,
+ struct GNUNET_HashCode *hc);
/**
/**
* Function called to validate a reply or a request. For
- * request evaluation, simply pass "NULL" for the reply_block.
+ * request evaluation, simply pass "NULL" for the @a reply_block.
* Note that it is assumed that the reply has already been
* matched to the key (and signatures checked) as it would
- * be done with the "get_key" function.
+ * be done with the #GNUNET_BLOCK_get_key() function.
*
* @param ctx block contxt
* @param type block type
+ * @param eo evaluation options to control evaluation
* @param query original query (hash)
* @param bf pointer to bloom filter associated with query; possibly updated (!)
- * @param bf_mutator mutation value for bf
+ * @param bf_mutator mutation value for @a bf
* @param xquery extrended query data (can be NULL, depending on type)
- * @param xquery_size number of bytes in xquery
+ * @param xquery_size number of bytes in @a xquery
* @param reply_block response to validate
- * @param reply_block_size number of bytes in reply block
+ * @param reply_block_size number of bytes in @a reply_block
* @return characterization of result
*/
enum GNUNET_BLOCK_EvaluationResult
GNUNET_BLOCK_evaluate (struct GNUNET_BLOCK_Context *ctx,
enum GNUNET_BLOCK_Type type,
- const struct GNUNET_HashCode * query,
+ enum GNUNET_BLOCK_EvaluationOptions eo,
+ const struct GNUNET_HashCode *query,
struct GNUNET_CONTAINER_BloomFilter **bf,
- int32_t bf_mutator, const void *xquery,
- size_t xquery_size, const void *reply_block,
+ int32_t bf_mutator,
+ const void *xquery,
+ size_t xquery_size,
+ const void *reply_block,
size_t reply_block_size);
* @param ctx block context
* @param type block type
* @param block block to get the key for
- * @param block_size number of bytes in block
+ * @param block_size number of bytes in @a block
* @param key set to the key (query) for the given block
- * @return GNUNET_YES on success,
- * GNUNET_NO if the block is malformed
- * GNUNET_SYSERR if type not supported
+ * @return #GNUNET_YES on success,
+ * #GNUNET_NO if the block is malformed
+ * #GNUNET_SYSERR if type not supported
* (or if extracting a key from a block of this type does not work)
*/
int
GNUNET_BLOCK_get_key (struct GNUNET_BLOCK_Context *ctx,
- enum GNUNET_BLOCK_Type type, const void *block,
- size_t block_size, struct GNUNET_HashCode * key);
+ enum GNUNET_BLOCK_Type type,
+ const void *block,
+ size_t block_size,
+ struct GNUNET_HashCode * key);
*
* @param bf_mutator mutation value to use
* @param seen_results results already seen
- * @param seen_results_count number of entries in 'seen_results'
+ * @param seen_results_count number of entries in @a seen_results
* @return NULL if seen_results_count is 0, otherwise a BF
* that would match the given results.
*/
struct GNUNET_CONTAINER_BloomFilter *
GNUNET_BLOCK_construct_bloomfilter (int32_t bf_mutator,
- const struct GNUNET_HashCode * seen_results,
+ const struct GNUNET_HashCode *seen_results,
unsigned int seen_results_count);
projects / oweals / gnunet.git / blobdiff