X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_block_plugin.h;h=f0438c82f0d18f28a2fca739138a3b20ab021ae1;hb=6e626937fd5133188d2bd06f280a1b889219eef2;hp=d7454b5d586c2371ed7bf3d8abc8f883ca5082ef;hpb=a3882b58f1c5976677aa65b0af8a48e8e946b06e;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_block_plugin.h b/src/include/gnunet_block_plugin.h index d7454b5d5..f0438c82f 100644 --- a/src/include/gnunet_block_plugin.h +++ b/src/include/gnunet_block_plugin.h @@ -2,20 +2,20 @@ This file is part of GNUnet Copyright (C) 2010,2013,2017 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 - by the Free Software Foundation; either version 3, or (at your - option) any later version. + GNUnet is free software: you can redistribute it and/or modify it + under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, + or (at your option) any later version. GNUnet is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. + Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . - 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., 51 Franklin Street, Fifth Floor, - Boston, MA 02110-1301, USA. + SPDX-License-Identifier: AGPL3.0-or-later */ /** @@ -39,10 +39,39 @@ #include "gnunet_block_lib.h" +/** + * Mark elements as "seen" using a hash of the element. Not supported + * by all block plugins. + * + * @param bg group to update + * @param seen_results results already seen + * @param seen_results_count number of entries in @a seen_results + */ +typedef void +(*GNUNET_BLOCK_GroupMarkSeenFunction)(struct GNUNET_BLOCK_Group *bg, + const struct GNUNET_HashCode *seen_results, + unsigned int seen_results_count); + + +/** + * Merge two groups, if possible. Not supported by all block plugins, + * can also fail if the nonces were different. + * + * @param bg1 group to update + * @param bg2 group to merge into @a bg1 + * @return #GNUNET_OK on success, #GNUNET_NO if the nonces were different and thus + * we failed. + */ +typedef int +(*GNUNET_BLOCK_GroupMergeFunction)(struct GNUNET_BLOCK_Group *bg1, + const struct GNUNET_BLOCK_Group *bg2); + + /** * Serialize state of a block group. * * @param bg group to serialize + * @param[out] nonce set to the nonce of the @a bg * @param[out] raw_data set to the serialized state * @param[out] raw_data_size set to the number of bytes in @a raw_data * @return #GNUNET_OK on success, #GNUNET_NO if serialization is not @@ -50,6 +79,7 @@ */ typedef int (*GNUNET_BLOCK_GroupSerializeFunction)(struct GNUNET_BLOCK_Group *bg, + uint32_t *nonce, void **raw_data, size_t *raw_data_size); @@ -86,6 +116,18 @@ struct GNUNET_BLOCK_Group */ GNUNET_BLOCK_GroupSerializeFunction serialize_cb; + /** + * Function to call to mark elements as seen in the group. + * Can be NULL if not supported. + */ + GNUNET_BLOCK_GroupMarkSeenFunction mark_seen_cb; + + /** + * Function to call to merge two groups. + * Can be NULL if not supported. + */ + GNUNET_BLOCK_GroupMergeFunction merge_cb; + /** * Function to call to destroy the block group. * Must not be NULL. @@ -108,6 +150,7 @@ struct GNUNET_BLOCK_Group * @param nonce random value used to seed the group creation * @param raw_data optional serialized prior state of the group, NULL if unavailable/fresh * @param raw_data_size number of bytes in @a raw_data, 0 if unavailable/fresh + * @param va variable arguments specific to @a type * @return block group handle, NULL if block groups are not supported * by this @a type of block (this is not an error) */ @@ -116,7 +159,8 @@ typedef struct GNUNET_BLOCK_Group * enum GNUNET_BLOCK_Type type, uint32_t nonce, const void *raw_data, - size_t raw_data_size); + size_t raw_data_size, + va_list va); /** @@ -127,11 +171,11 @@ typedef struct GNUNET_BLOCK_Group * * be done with the "get_key" function. * * @param cls closure + * @param ctx block context * @param type block type + * @param group which block group to use for evaluation * @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 * @param xquery extrended query data (can be NULL, depending on type) * @param xquery_size number of bytes in @a xquery * @param reply_block response to validate @@ -140,11 +184,11 @@ typedef struct GNUNET_BLOCK_Group * */ typedef enum GNUNET_BLOCK_EvaluationResult (*GNUNET_BLOCK_EvaluationFunction) (void *cls, + struct GNUNET_BLOCK_Context *ctx, enum GNUNET_BLOCK_Type type, + struct GNUNET_BLOCK_Group *group, 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,