plugin_block_consensus.c File Reference

consensus block, either nested block or marker More...

#include "platform.h"
#include "consensus_protocol.h"
#include "gnunet_block_plugin.h"
#include "gnunet_block_group_lib.h"

Include dependency graph for plugin_block_consensus.c:

Go to the source code of this file.

Functions
static enum GNUNET_BLOCK_EvaluationResult	block_plugin_consensus_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_consensus_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_consensus_init (void *cls)
	Entry point for the plugin. More...
void *	libgnunet_plugin_block_consensus_done (void *cls)
	Exit point from the plugin. More...

Detailed Description

consensus block, either nested block or marker

Author

Christian Grothoff

Definition in file plugin_block_consensus.c.

Function Documentation

block_plugin_consensus_evaluate()

static enum GNUNET_BLOCK_EvaluationResult block_plugin_consensus_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

cls	closure
ctx	context
type	block type
group	block group to use
eo	control flags
query	original query (hash)
xquery	extrended query data (can be NULL, depending on type)
xquery_size	number of bytes in xquery
reply_block	response to validate
reply_block_size	number of bytes in reply block

Returns

characterization of result

Definition at line 50 of file plugin_block_consensus.c.

References GNUNET_BLOCK_evaluate(), GNUNET_BLOCK_EVALUATION_OK_MORE, GNUNET_BLOCK_EVALUATION_RESULT_INVALID, ConsensusElement::marker, and ConsensusElement::payload_type.

Referenced by libgnunet_plugin_block_consensus_init().

{
  const struct ConsensusElement *ce = reply_block;

  if (reply_block_size < sizeof(struct ConsensusElement))
    return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
  if ( (0 != ce->marker) ||
       (0 == ce->payload_type) )
    return GNUNET_BLOCK_EVALUATION_OK_MORE;

  return GNUNET_BLOCK_evaluate (ctx,
                                type,
                                group,
                                eo,
                                query,
                                xquery,
                                xquery_size,
                                &ce[1],
                                reply_block_size
                                - sizeof(struct ConsensusElement));
}

Here is the call graph for this function:

Here is the caller graph for this function:

block_plugin_consensus_get_key()

static int block_plugin_consensus_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

cls	closure
type	block type
block	block to get the key for
block_size	number of bytes in block
key	set 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 94 of file plugin_block_consensus.c.

References GNUNET_SYSERR.

Referenced by libgnunet_plugin_block_consensus_init().

{
  return GNUNET_SYSERR;
}

Here is the caller graph for this function:

libgnunet_plugin_block_consensus_init()

void* libgnunet_plugin_block_consensus_init

(

void *

cls

)

Entry point for the plugin.

Definition at line 108 of file plugin_block_consensus.c.

References block_plugin_consensus_evaluate(), block_plugin_consensus_get_key(), GNUNET_BLOCK_PluginFunctions::evaluate, GNUNET_BLOCK_PluginFunctions::get_key, GNUNET_BLOCK_TYPE_ANY, GNUNET_BLOCK_TYPE_CONSENSUS_ELEMENT, GNUNET_new, and GNUNET_BLOCK_PluginFunctions::types.

{
  static enum GNUNET_BLOCK_Type types[] = {
    GNUNET_BLOCK_TYPE_CONSENSUS_ELEMENT,
    GNUNET_BLOCK_TYPE_ANY       /* end of list */
  };
  struct GNUNET_BLOCK_PluginFunctions *api;

  api = GNUNET_new (struct GNUNET_BLOCK_PluginFunctions);
  api->evaluate = &block_plugin_consensus_evaluate;
  api->get_key = &block_plugin_consensus_get_key;
  api->types = types;
  return api;
}

Here is the call graph for this function:

libgnunet_plugin_block_consensus_done()

void* libgnunet_plugin_block_consensus_done

(

void *

cls

)

Exit point from the plugin.

Definition at line 128 of file plugin_block_consensus.c.

References GNUNET_BLOCK_PluginFunctions::cls, and GNUNET_free.

{
  struct GNUNET_BLOCK_PluginFunctions *api = cls;

  GNUNET_free (api);
  return NULL;
}