consensus_api.c File Reference

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_protocols.h"
#include "gnunet_consensus_service.h"
#include "consensus.h"

Include dependency graph for consensus_api.c:

Go to the source code of this file.

Data Structures
struct	GNUNET_CONSENSUS_Handle
	Handle for the service. More...
struct	InsertDoneInfo
	FIXME: this should not bee necessary when the API issue has been fixed. More...

Macros
#define	LOG(kind, ...)   GNUNET_log_from (kind, "consensus-api", __VA_ARGS__)

Functions
static int	check_new_element (void *cls, const struct GNUNET_CONSENSUS_ElementMessage *msg)
	Called when the server has sent is a new element.
static void	handle_new_element (void *cls, const struct GNUNET_CONSENSUS_ElementMessage *msg)
	Called when the server has sent is a new element.
static void	handle_conclude_done (void *cls, const struct GNUNET_MessageHeader *msg)
	Called when the server has announced that the conclusion is over.
static void	mq_error_handler (void *cls, enum GNUNET_MQ_Error error)
	Generic error handler, called with the appropriate error code and the same closure specified at the creation of the message queue.
struct GNUNET_CONSENSUS_Handle *	GNUNET_CONSENSUS_create (const struct GNUNET_CONFIGURATION_Handle *cfg, unsigned int num_peers, const struct GNUNET_PeerIdentity *peers, const struct GNUNET_HashCode *session_id, struct GNUNET_TIME_Absolute start, struct GNUNET_TIME_Absolute deadline, GNUNET_CONSENSUS_ElementCallback new_element_cb, void *new_element_cls)
	Create a consensus session.
static void	idc_adapter (void *cls)
void	GNUNET_CONSENSUS_insert (struct GNUNET_CONSENSUS_Handle *consensus, const struct GNUNET_SET_Element *element, GNUNET_CONSENSUS_InsertDoneCallback idc, void *idc_cls)
	Insert an element in the set being reconsiled.
void	GNUNET_CONSENSUS_conclude (struct GNUNET_CONSENSUS_Handle *consensus, GNUNET_CONSENSUS_ConcludeCallback conclude, void *conclude_cls)
	We are done with inserting new elements into the consensus; try to conclude the consensus within a given time window.
void	GNUNET_CONSENSUS_destroy (struct GNUNET_CONSENSUS_Handle *consensus)
	Destroy a consensus handle (free all state associated with it, no longer call any of the callbacks).

Detailed Description

Author

Florian Dold

Definition in file consensus_api.c.

Macro Definition Documentation

LOG

#define LOG	(		kind,
			...
	)		GNUNET_log_from (kind, "consensus-api", __VA_ARGS__)

Definition at line 33 of file consensus_api.c.

Function Documentation

check_new_element()

static int check_new_element ( void *  cls, const struct GNUNET_CONSENSUS_ElementMessage *  msg  )

static

Called when the server has sent is a new element.

Parameters

cls	consensus handle
msg	element message

Definition at line 106 of file consensus_api.c.

{
  /* any size is fine, elements are variable-size */
  return GNUNET_OK;
}

References GNUNET_OK.

handle_new_element()

static void handle_new_element ( void *  cls, const struct GNUNET_CONSENSUS_ElementMessage *  msg  )

static

Called when the server has sent is a new element.

Parameters

cls	consensus handle
msg	element message

Definition at line 121 of file consensus_api.c.

{
  struct GNUNET_CONSENSUS_Handle *consensus = cls;
  struct GNUNET_SET_Element element;
 
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "received new element\n");
  element.element_type = msg->element_type;
  element.size = ntohs (msg->header.size) - sizeof(struct
                                                   GNUNET_CONSENSUS_ElementMessage);
  element.data = &msg[1];
  consensus->new_element_cb (consensus->new_element_cls,
                             &element);
}

References GNUNET_SET_Element::data, GNUNET_SET_Element::element_type, GNUNET_ERROR_TYPE_DEBUG, LOG, msg, GNUNET_CONSENSUS_Handle::new_element_cb, GNUNET_CONSENSUS_Handle::new_element_cls, GNUNET_MessageHeader::size, and GNUNET_SET_Element::size.

handle_conclude_done()

static void handle_conclude_done ( void *  cls, const struct GNUNET_MessageHeader *  msg  )

static

Called when the server has announced that the conclusion is over.

Parameters

cls	consensus handle
msg	conclude done message

Definition at line 146 of file consensus_api.c.

{
  struct GNUNET_CONSENSUS_Handle *consensus = cls;
  GNUNET_CONSENSUS_ConcludeCallback cc;
 
  GNUNET_MQ_destroy (consensus->mq);
  consensus->mq = NULL;
  GNUNET_assert (NULL != (cc = consensus->conclude_cb));
  consensus->conclude_cb = NULL;
  cc (consensus->conclude_cls);
}

References GNUNET_CONSENSUS_Handle::conclude_cb, GNUNET_CONSENSUS_Handle::conclude_cls, GNUNET_assert, GNUNET_MQ_destroy(), and GNUNET_CONSENSUS_Handle::mq.

Here is the call graph for this function:

mq_error_handler()

static void mq_error_handler ( void *  cls, enum GNUNET_MQ_Error  error  )

static

Generic error handler, called with the appropriate error code and the same closure specified at the creation of the message queue.

Not every message queue implementation supports an error handler.

Parameters

cls	closure, same closure as for the message handlers
error	error code

Definition at line 170 of file consensus_api.c.

{
  LOG (GNUNET_ERROR_TYPE_WARNING,
       "consensus service disconnected us\n");
}

References GNUNET_ERROR_TYPE_WARNING, and LOG.

Referenced by GNUNET_CONSENSUS_create().

Here is the caller graph for this function:

idc_adapter()

static void idc_adapter ( void *  cls )

static

Definition at line 253 of file consensus_api.c.

{
  struct InsertDoneInfo *i = cls;
 
  i->idc (i->cls, GNUNET_OK);
  GNUNET_free (i);
}

References InsertDoneInfo::cls, GNUNET_free, GNUNET_OK, and InsertDoneInfo::idc.

Referenced by GNUNET_CONSENSUS_insert().

Here is the caller graph for this function: