GNUnet  0.11.x
Functions
plugin_block_set_test.c File Reference

set test block, recognizes elements with non-zero first byte as invalid More...

#include "platform.h"
#include "gnunet_block_plugin.h"
#include "gnunet_block_group_lib.h"
Include dependency graph for plugin_block_set_test.c:

Go to the source code of this file.

Functions

static enum GNUNET_BLOCK_EvaluationResult block_plugin_set_test_evaluate (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, const void *xquery, size_t xquery_size, const void *reply_block, size_t reply_block_size)
 Function called to validate a reply or a request. More...
 
static int block_plugin_set_test_get_key (void *cls, enum GNUNET_BLOCK_Type type, const void *block, size_t block_size, struct GNUNET_HashCode *key)
 Function called to obtain the key for a block. More...
 
void * libgnunet_plugin_block_set_test_init (void *cls)
 Entry point for the plugin. More...
 
void * libgnunet_plugin_block_set_test_done (void *cls)
 Exit point from the plugin. More...
 

Detailed Description

set test block, recognizes elements with non-zero first byte as invalid

Author
Christian Grothoff

Definition in file plugin_block_set_test.c.

Function Documentation

◆ block_plugin_set_test_evaluate()

static enum GNUNET_BLOCK_EvaluationResult block_plugin_set_test_evaluate ( 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,
const void *  xquery,
size_t  xquery_size,
const void *  reply_block,
size_t  reply_block_size 
)
static

Function called to validate a reply or a request.

For request evaluation, simply pass "NULL" for the reply_block.

Parameters
clsclosure
ctxblock context
typeblock type
groupblock group to use
eocontrol flags
queryoriginal query (hash)
xqueryextrended query data (can be NULL, depending on type)
xquery_sizenumber of bytes in xquery
reply_blockresponse to validate
reply_block_sizenumber of bytes in reply block
Returns
characterization of result

Definition at line 49 of file plugin_block_set_test.c.

References GNUNET_BLOCK_EVALUATION_OK_MORE, and GNUNET_BLOCK_EVALUATION_RESULT_INVALID.

Referenced by libgnunet_plugin_block_set_test_init().

59 {
60  if ((NULL == reply_block) ||
61  (reply_block_size == 0) ||
62  (0 != ((char *) reply_block)[0]))
65 }
Block does not match query (invalid result)
Valid result, and there may be more.
Here is the caller graph for this function:

◆ block_plugin_set_test_get_key()

static int block_plugin_set_test_get_key ( void *  cls,
enum GNUNET_BLOCK_Type  type,
const void *  block,
size_t  block_size,
struct GNUNET_HashCode key 
)
static

Function called to obtain the key for a block.

Parameters
clsclosure
typeblock type
blockblock to get the key for
block_sizenumber of bytes in block
keyset to the key (query) for the given block
Returns
GNUNET_OK on success, GNUNET_SYSERR if type not supported (or if extracting a key from a block of this type does not work)

Definition at line 80 of file plugin_block_set_test.c.

References GNUNET_SYSERR.

Referenced by libgnunet_plugin_block_set_test_init().

85 {
86  return GNUNET_SYSERR;
87 }
#define GNUNET_SYSERR
Definition: gnunet_common.h:76
Here is the caller graph for this function:

◆ libgnunet_plugin_block_set_test_init()

void* libgnunet_plugin_block_set_test_init ( void *  cls)

Entry point for the plugin.

Definition at line 94 of file plugin_block_set_test.c.

References block_plugin_set_test_evaluate(), block_plugin_set_test_get_key(), GNUNET_BLOCK_PluginFunctions::evaluate, GNUNET_BLOCK_PluginFunctions::get_key, GNUNET_BLOCK_TYPE_ANY, GNUNET_BLOCK_TYPE_SET_TEST, GNUNET_new, and GNUNET_BLOCK_PluginFunctions::types.

95 {
96  static enum GNUNET_BLOCK_Type types[] = {
98  GNUNET_BLOCK_TYPE_ANY /* end of list */
99  };
100  struct GNUNET_BLOCK_PluginFunctions *api;
101 
105  api->types = types;
106  return api;
107 }
enum GNUNET_BLOCK_Type * types
0-terminated array of block types supported by this plugin.
Any type of block, used as a wildcard when searching.
GNUNET_BLOCK_EvaluationFunction evaluate
Main function of a block plugin.
GNUNET_BLOCK_Type
Blocks in the datastore and the datacache must have a unique type.
Each plugin is required to return a pointer to a struct of this type as the return value from its ent...
#define GNUNET_new(type)
Allocate a struct or union of the given type.
static enum GNUNET_BLOCK_EvaluationResult block_plugin_set_test_evaluate(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, const void *xquery, size_t xquery_size, const void *reply_block, size_t reply_block_size)
Function called to validate a reply or a request.
GNUNET_BLOCK_GetKeyFunction get_key
Obtain the key for a given block (if possible).
Block for testing set/consensus.
static int block_plugin_set_test_get_key(void *cls, enum GNUNET_BLOCK_Type type, const void *block, size_t block_size, struct GNUNET_HashCode *key)
Function called to obtain the key for a block.
Here is the call graph for this function:

◆ libgnunet_plugin_block_set_test_done()

void* libgnunet_plugin_block_set_test_done ( void *  cls)

Exit point from the plugin.

Definition at line 114 of file plugin_block_set_test.c.

References GNUNET_BLOCK_PluginFunctions::cls, and GNUNET_free.

115 {
116  struct GNUNET_BLOCK_PluginFunctions *api = cls;
117 
118  GNUNET_free (api);
119  return NULL;
120 }
Each plugin is required to return a pointer to a struct of this type as the return value from its ent...
void * cls
Closure for all of the callbacks.
#define GNUNET_free(ptr)
Wrapper around free.