2 This file is part of GNUnet.
3 Copyright (C) 2010 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your option) any later version.
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 Affero General Public License for more details.
17 * @author Christian Grothoff
20 * Library for creating block groups (to be used by block plugins)
22 * @defgroup block Block group library
23 * Library for data group management
26 #ifndef GNUNET_BLOCK_GROUP_LIB_H
27 #define GNUNET_BLOCK_GROUP_LIB_H
29 #include "gnunet_util_lib.h"
30 #include "gnunet_block_lib.h"
35 #if 0 /* keep Emacsens' auto-indent happy */
42 * How many bytes should a bloomfilter be if we have already seen
43 * entry_count responses? Sized so that do not have to
44 * re-size the filter too often (to keep it cheap).
46 * Since other peers will also add entries but not resize the filter,
47 * we should generally pick a slightly larger size than what the
48 * strict math would suggest.
50 * @param entry_count expected number of entries in the Bloom filter
51 * @param k number of bits set per entry
52 * @return must be a power of two and smaller or equal to 2^15.
55 GNUNET_BLOCK_GROUP_compute_bloomfilter_size (unsigned int entry_count,
60 * Create a new block group that filters duplicates using a Bloom filter.
62 * @param ctx block context in which the block group is created
63 * @param bf_size size of the Bloom filter
64 * @param bf_k K-value for the Bloom filter
65 * @param type block type
66 * @param nonce random value used to seed the group creation
67 * @param raw_data optional serialized prior state of the group, NULL if unavailable/fresh
68 * @param raw_data_size number of bytes in @a raw_data, 0 if unavailable/fresh
69 * @return block group handle, NULL if block groups are not supported
70 * by this @a type of block (this is not an error)
72 struct GNUNET_BLOCK_Group *
73 GNUNET_BLOCK_GROUP_bf_create (void *cls,
76 enum GNUNET_BLOCK_Type type,
79 size_t raw_data_size);
83 * Test if @a hc is contained in the Bloom filter of @a bg. If so,
84 * return #GNUNET_YES. If not, add @a hc to the Bloom filter and
87 * @param bg block group to use for testing
88 * @param hc hash of element to evaluate
89 * @return #GNUNET_YES if @a hc is (likely) a duplicate
90 * #GNUNET_NO if @a hc was definitively not in @bg (but now is)
93 GNUNET_BLOCK_GROUP_bf_test_and_set (struct GNUNET_BLOCK_Group *bg,
94 const struct GNUNET_HashCode *hc);
97 #if 0 /* keep Emacsens' auto-indent happy */
104 /* ifndef GNUNET_BLOCK_GROUP_LIB_H */
107 /** @} */ /* end of group */
109 /* end of gnunet_block_group_lib.h */