/*
This file is part of GNUnet.
- (C) 2010 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2010 GNUnet e.V.
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.
*/
/**
- * @file include/gnunet_block_lib.h
- * @brief library for data block manipulation
* @author Christian Grothoff
+ *
+ * @file
+ * Library for data block manipulation
+ *
+ * @defgroup block Block library
+ * Library for data block manipulation
+ * @{
*/
#ifndef GNUNET_BLOCK_LIB_H
#define GNUNET_BLOCK_LIB_H
/**
* Type of a block that contains a HELLO for a peer (for
- * DHT find-peer operations).
+ * DHT and CADET find-peer operations).
*/
GNUNET_BLOCK_TYPE_DHT_HELLO = 7,
* Block for testing.
*/
GNUNET_BLOCK_TYPE_TEST = 8,
-
+
/**
* Type of a block representing any type of search result
* (universal). Implemented in the context of #2564, replaces
GNUNET_BLOCK_TYPE_GNS_NAMERECORD = 11,
/**
- * Block for storing mesh peers
+ * Block to store a cadet regex state
*/
- GNUNET_BLOCK_TYPE_MESH_PEER = 20,
+ GNUNET_BLOCK_TYPE_REGEX = 22,
/**
- * Block to store a mesh regex state
+ * Block to store a cadet regex accepting state
*/
- GNUNET_BLOCK_TYPE_REGEX = 22,
+ GNUNET_BLOCK_TYPE_REGEX_ACCEPT = 23
+};
+
+
+/**
+ * Flags that can be set to control the evaluation.
+ */
+enum GNUNET_BLOCK_EvaluationOptions
+{
/**
- * Block to store a mesh regex accepting state
+ * Default behavior.
*/
- GNUNET_BLOCK_TYPE_REGEX_ACCEPT = 23
+ GNUNET_BLOCK_EO_NONE = 0,
+
+ /**
+ * The block is obtained from the local database, skip cryptographic
+ * checks.
+ */
+ GNUNET_BLOCK_EO_LOCAL_SKIP_CRYPTO = 1
};
* Valid result, and there may be more.
*/
GNUNET_BLOCK_EVALUATION_OK_MORE = 0,
-
+
/**
* Last possible valid result.
*/
* @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 @a bf
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);
*/
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);
*/
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);
}
#endif
-
/* ifndef GNUNET_BLOCK_LIB_H */
#endif
+
+/** @} */ /* end of group */
+
/* end of gnunet_block_lib.h */