gnunet_block_plugin.h

Go to the documentation of this file.

/*
     This file is part of GNUnet
     Copyright (C) 2010, 2013, 2017, 2021, 2022 GNUnet e.V.
 
     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
     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 <http://www.gnu.org/licenses/>.
 
     SPDX-License-Identifier: AGPL3.0-or-later
 */
 
#ifndef PLUGIN_BLOCK_H
#define PLUGIN_BLOCK_H
 
 
#include "gnunet_util_lib.h"
#include "gnunet_block_lib.h"
 
 
typedef void
(*GNUNET_BLOCK_GroupMarkSeenFunction)(
  struct GNUNET_BLOCK_Group *bg,
  const struct GNUNET_HashCode *seen_results,
  unsigned int seen_results_count);
 
 
typedef enum GNUNET_GenericReturnValue
(*GNUNET_BLOCK_GroupMergeFunction)(struct GNUNET_BLOCK_Group *bg1,
                                   const struct GNUNET_BLOCK_Group *bg2);
 
 
typedef enum GNUNET_GenericReturnValue
(*GNUNET_BLOCK_GroupSerializeFunction)(struct GNUNET_BLOCK_Group *bg,
                                       void **raw_data,
                                       size_t *raw_data_size);
 
 
typedef void
(*GNUNET_BLOCK_GroupDestroyFunction)(struct GNUNET_BLOCK_Group *bg);
 
 
struct GNUNET_BLOCK_Group
{
  struct GNUENT_BLOCK_Context *ctx;
 
  enum GNUNET_BLOCK_Type type;
 
  GNUNET_BLOCK_GroupSerializeFunction serialize_cb;
 
  GNUNET_BLOCK_GroupMarkSeenFunction mark_seen_cb;
 
  GNUNET_BLOCK_GroupMergeFunction merge_cb;
 
  GNUNET_BLOCK_GroupDestroyFunction destroy_cb;
 
  void *internal_cls;
};
 
 
typedef struct GNUNET_BLOCK_Group *
(*GNUNET_BLOCK_GroupCreateFunction)(void *cls,
                                    enum GNUNET_BLOCK_Type type,
                                    const void *raw_data,
                                    size_t raw_data_size,
                                    va_list va);
 
 
typedef enum GNUNET_GenericReturnValue
(*GNUNET_BLOCK_QueryEvaluationFunction)(void *cls,
                                        enum GNUNET_BLOCK_Type type,
                                        const struct GNUNET_HashCode *query,
                                        const void *xquery,
                                        size_t xquery_size);
 
 
typedef enum GNUNET_GenericReturnValue
(*GNUNET_BLOCK_BlockEvaluationFunction)(void *cls,
                                        enum GNUNET_BLOCK_Type type,
                                        const void *block,
                                        size_t block_size);
 
 
typedef enum GNUNET_BLOCK_ReplyEvaluationResult
(*GNUNET_BLOCK_ReplyEvaluationFunction)(void *cls,
                                        enum GNUNET_BLOCK_Type type,
                                        struct GNUNET_BLOCK_Group *group,
                                        const struct GNUNET_HashCode *query,
                                        const void *xquery,
                                        size_t xquery_size,
                                        const void *reply_block,
                                        size_t reply_block_size);
 
 
typedef enum GNUNET_GenericReturnValue
(*GNUNET_BLOCK_GetKeyFunction)(void *cls,
                               enum GNUNET_BLOCK_Type type,
                               const void *block,
                               size_t block_size,
                               struct GNUNET_HashCode *key);
 
 
struct GNUNET_BLOCK_PluginFunctions
{
  void *cls;
 
  const enum GNUNET_BLOCK_Type *types;
 
  GNUNET_BLOCK_GetKeyFunction get_key;
 
  GNUNET_BLOCK_GroupCreateFunction create_group;
 
  GNUNET_BLOCK_QueryEvaluationFunction check_query;
 
  GNUNET_BLOCK_BlockEvaluationFunction check_block;
 
  GNUNET_BLOCK_ReplyEvaluationFunction check_reply;
 
};
 
#endif
  /* end of group */
 /* end of group addition */