setu_api.c File Reference

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_protocols.h"
#include "gnunet_setu_service.h"
#include "setu.h"

Include dependency graph for setu_api.c:

Go to the source code of this file.

Data Structures
struct	GNUNET_SETU_Handle
	Opaque handle to a set. More...
struct	GNUNET_SETU_Request
	Handle for a set operation request from another peer. More...
struct	GNUNET_SETU_OperationHandle
	Handle to an operation. More...
struct	GNUNET_SETU_ListenHandle
	Opaque handle to a listen operation. More...

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

Functions
static int	check_result (void *cls, const struct GNUNET_SETU_ResultMessage *msg)
	Check that the given msg is well-formed. More...
static void	handle_result (void *cls, const struct GNUNET_SETU_ResultMessage *msg)
	Handle result message for a set operation. More...
static void	set_operation_destroy (struct GNUNET_SETU_OperationHandle *oh)
	Destroy the given set operation. More...
void	GNUNET_SETU_operation_cancel (struct GNUNET_SETU_OperationHandle *oh)
	Cancel the given set operation. More...
static void	handle_client_set_error (void *cls, enum GNUNET_MQ_Error error)
	We encountered an error communicating with the set service while performing a set operation. More...
struct GNUNET_SETU_Handle *	GNUNET_SETU_create (const struct GNUNET_CONFIGURATION_Handle *cfg)
	Create an empty set, supporting the specified operation. More...
int	GNUNET_SETU_add_element (struct GNUNET_SETU_Handle *set, const struct GNUNET_SETU_Element *element, GNUNET_SCHEDULER_TaskCallback cb, void *cb_cls)
	Add an element to the given set. More...
void	GNUNET_SETU_destroy (struct GNUNET_SETU_Handle *set)
	Destroy the set handle if no operations are left, mark the set for destruction otherwise. More...
struct GNUNET_SETU_OperationHandle *	GNUNET_SETU_prepare (const struct GNUNET_PeerIdentity *other_peer, const struct GNUNET_HashCode *app_id, const struct GNUNET_MessageHeader *context_msg, const struct GNUNET_SETU_Option options[], GNUNET_SETU_ResultIterator result_cb, void *result_cls)
	Prepare a set operation to be evaluated with another peer. More...
static void	listen_connect (void *cls)
	Connect to the set service in order to listen for requests. More...
static int	check_request (void *cls, const struct GNUNET_SETU_RequestMessage *msg)
	Check validity of request message for a listen operation. More...
static void	handle_request (void *cls, const struct GNUNET_SETU_RequestMessage *msg)
	Handle request message for a listen operation. More...
static void	handle_client_listener_error (void *cls, enum GNUNET_MQ_Error error)
	Our connection with the set service encountered an error, re-initialize with exponential back-off. More...
struct GNUNET_SETU_ListenHandle *	GNUNET_SETU_listen (const struct GNUNET_CONFIGURATION_Handle *cfg, const struct GNUNET_HashCode *app_id, GNUNET_SETU_ListenCallback listen_cb, void *listen_cls)
	Wait for set operation requests for the given application id. More...
void	GNUNET_SETU_listen_cancel (struct GNUNET_SETU_ListenHandle *lh)
	Cancel the given listen operation. More...
struct GNUNET_SETU_OperationHandle *	GNUNET_SETU_accept (struct GNUNET_SETU_Request *request, const struct GNUNET_SETU_Option options[], GNUNET_SETU_ResultIterator result_cb, void *result_cls)
	Accept a request we got via GNUNET_SETU_listen(). More...
int	GNUNET_SETU_commit (struct GNUNET_SETU_OperationHandle *oh, struct GNUNET_SETU_Handle *set)
	Commit a set to be used with a set operation. More...
void	GNUNET_SETU_element_hash (const struct GNUNET_SETU_Element *element, struct GNUNET_HashCode *ret_hash)
	Hash a set element. More...

Macro Definition Documentation

LOG

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

Definition at line 34 of file setu_api.c.

Function Documentation

check_result()

static int check_result ( void *  cls, const struct GNUNET_SETU_ResultMessage *  msg  )

static

Check that the given msg is well-formed.

Parameters

cls	closure
msg	message to check

Returns

GNUNET_OK if message is well-formed

Definition at line 196 of file setu_api.c.

{
  /* minimum size was already checked, everything else is OK! */
  return GNUNET_OK;
}

References GNUNET_OK.

handle_result()

static void handle_result ( void *  cls, const struct GNUNET_SETU_ResultMessage *  msg  )

static

Handle result message for a set operation.

Parameters

cls	the set
mh	the message

Definition at line 211 of file setu_api.c.

{
  struct GNUNET_SETU_Handle *set = cls;
  struct GNUNET_SETU_OperationHandle *oh;
  struct GNUNET_SETU_Element e;
  enum GNUNET_SETU_Status result_status;
  int destroy_set;
 
  GNUNET_assert (NULL != set->mq);
  result_status = ntohs (msg->result_status);
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "Got result message with status %d\n",
       result_status);
  oh = GNUNET_MQ_assoc_get (set->mq,
                            ntohl (msg->request_id));
  if (NULL == oh)
  {
    /* 'oh' can be NULL if we canceled the operation, but the service
       did not get the cancel message yet. */
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "Ignoring result from canceled operation\n");
    return;
  }
 
  switch (result_status)
  {
  case GNUNET_SETU_STATUS_ADD_LOCAL:
  case GNUNET_SETU_STATUS_ADD_REMOTE:
    e.data = &msg[1];
    e.size = ntohs (msg->header.size)
             - sizeof(struct GNUNET_SETU_ResultMessage);
    e.element_type = ntohs (msg->element_type);
    if (NULL != oh->result_cb)
      oh->result_cb (oh->result_cls,
                     &e,
                     GNUNET_ntohll (msg->current_size),
                     result_status);
    return;
  case GNUNET_SETU_STATUS_FAILURE:
  case GNUNET_SETU_STATUS_DONE:
    LOG (GNUNET_ERROR_TYPE_DEBUG,
         "Treating result as final status\n");
    GNUNET_MQ_assoc_remove (set->mq,
                            ntohl (msg->request_id));
    GNUNET_CONTAINER_DLL_remove (set->ops_head,
                                 set->ops_tail,
                                 oh);
    /* Need to do this calculation _before_ the result callback,
       as IF the application still has a valid set handle, it
       may trigger destruction of the set during the callback. */
    destroy_set = (GNUNET_YES == set->destroy_requested) &&
                  (NULL == set->ops_head);
    if (NULL != oh->result_cb)
    {
      oh->result_cb (oh->result_cls,
                     NULL,
                     GNUNET_ntohll (msg->current_size),
                     result_status);
    }
    else
    {
      LOG (GNUNET_ERROR_TYPE_DEBUG,
           "No callback for final status\n");
    }
    if (destroy_set)
      GNUNET_SETU_destroy (set);
    GNUNET_free (oh);
    return;
  }
}

References GNUNET_SETU_Element::data, GNUNET_SETU_Handle::destroy_requested, GNUNET_SETU_Element::element_type, GNUNET_assert, GNUNET_CONTAINER_DLL_remove, GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_log, GNUNET_MQ_assoc_get(), GNUNET_MQ_assoc_remove(), GNUNET_ntohll(), GNUNET_SETU_destroy(), GNUNET_SETU_STATUS_ADD_LOCAL, GNUNET_SETU_STATUS_ADD_REMOTE, GNUNET_SETU_STATUS_DONE, GNUNET_SETU_STATUS_FAILURE, GNUNET_YES, LOG, GNUNET_SETU_Handle::mq, msg, GNUNET_SETU_Handle::ops_head, GNUNET_SETU_Handle::ops_tail, GNUNET_SETU_OperationHandle::result_cb, GNUNET_SETU_OperationHandle::result_cls, GNUNET_SETU_ResultMessage::result_status, GNUNET_MessageHeader::size, and GNUNET_SETU_Element::size.

Here is the call graph for this function:

set_operation_destroy()

static void set_operation_destroy ( struct GNUNET_SETU_OperationHandle *  oh )

static

Destroy the given set operation.

Parameters

oh	set operation to destroy

Definition at line 290 of file setu_api.c.

{
  struct GNUNET_SETU_Handle *set = oh->set;
  struct GNUNET_SETU_OperationHandle *h_assoc;
 
  if (NULL != oh->conclude_mqm)
    GNUNET_MQ_discard (oh->conclude_mqm);
  /* is the operation already committed? */
  if (NULL != set)
  {
    GNUNET_CONTAINER_DLL_remove (set->ops_head,
                                 set->ops_tail,
                                 oh);
    h_assoc = GNUNET_MQ_assoc_remove (set->mq,
                                      oh->request_id);
    GNUNET_assert ((NULL == h_assoc) ||
                   (h_assoc == oh));
  }
  GNUNET_free (oh);
}

References GNUNET_SETU_OperationHandle::conclude_mqm, GNUNET_assert, GNUNET_CONTAINER_DLL_remove, GNUNET_free, GNUNET_MQ_assoc_remove(), GNUNET_MQ_discard(), GNUNET_SETU_Handle::mq, GNUNET_SETU_Handle::ops_head, GNUNET_SETU_Handle::ops_tail, GNUNET_SETU_OperationHandle::request_id, and GNUNET_SETU_OperationHandle::set.

Referenced by GNUNET_SETU_operation_cancel(), and handle_client_set_error().

Here is the call graph for this function:

Here is the caller graph for this function:

handle_client_set_error()

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

static

We encountered an error communicating with the set service while performing a set operation.

Report to the application.

Parameters

cls	the struct GNUNET_SETU_Handle
error	error code

Definition at line 354 of file setu_api.c.

{
  struct GNUNET_SETU_Handle *set = cls;
 
  LOG (GNUNET_ERROR_TYPE_ERROR,
       "Handling client set error %d\n",
       error);
  while (NULL != set->ops_head)
  {
    if ((NULL != set->ops_head->result_cb) &&
        (GNUNET_NO == set->destroy_requested))
      set->ops_head->result_cb (set->ops_head->result_cls,
                                NULL,
                                0,
                                GNUNET_SETU_STATUS_FAILURE);
    set_operation_destroy (set->ops_head);
  }
  set->invalid = GNUNET_YES;
}

References GNUNET_SETU_Handle::destroy_requested, GNUNET_ERROR_TYPE_ERROR, GNUNET_NO, GNUNET_SETU_STATUS_FAILURE, GNUNET_YES, GNUNET_SETU_Handle::invalid, LOG, GNUNET_SETU_Handle::ops_head, GNUNET_SETU_OperationHandle::result_cb, GNUNET_SETU_OperationHandle::result_cls, and set_operation_destroy().

Referenced by GNUNET_SETU_create().

Here is the call graph for this function:

Here is the caller graph for this function:

listen_connect()

static void listen_connect ( void *  cls )

static

Connect to the set service in order to listen for requests.

Parameters

cls	the struct GNUNET_SETU_ListenHandle * to connect

Definition at line 675 of file setu_api.c.

{
  struct GNUNET_SETU_ListenHandle *lh = cls;
  struct GNUNET_MQ_MessageHandler mq_handlers[] = {
    GNUNET_MQ_hd_var_size (request,
                           GNUNET_MESSAGE_TYPE_SETU_REQUEST,
                           struct GNUNET_SETU_RequestMessage,
                           lh),
    GNUNET_MQ_handler_end ()
  };
  struct GNUNET_MQ_Envelope *mqm;
  struct GNUNET_SETU_ListenMessage *msg;
 
  lh->reconnect_task = NULL;
  GNUNET_assert (NULL == lh->mq);
  lh->mq = GNUNET_CLIENT_connect (lh->cfg,
                                  "setu",
                                  mq_handlers,
                                  &handle_client_listener_error,
                                  lh);
  if (NULL == lh->mq)
    return;
  mqm = GNUNET_MQ_msg (msg,
                       GNUNET_MESSAGE_TYPE_SETU_LISTEN);
  msg->app_id = lh->app_id;
  GNUNET_MQ_send (lh->mq,
                  mqm);
}

References GNUNET_SETU_ListenHandle::app_id, GNUNET_SETU_ListenHandle::cfg, GNUNET_assert, GNUNET_CLIENT_connect(), GNUNET_MESSAGE_TYPE_SETU_LISTEN, GNUNET_MESSAGE_TYPE_SETU_REQUEST, GNUNET_MQ_handler_end, GNUNET_MQ_hd_var_size, GNUNET_MQ_msg, GNUNET_MQ_send(), handle_client_listener_error(), GNUNET_SETU_ListenHandle::mq, msg, GNUNET_SETU_ListenHandle::reconnect_task, and request.

Referenced by GNUNET_SETU_listen(), and handle_client_listener_error().

Here is the call graph for this function:

Here is the caller graph for this function:

check_request()

static int check_request ( void *  cls, const struct GNUNET_SETU_RequestMessage *  msg  )

static

Check validity of request message for a listen operation.

Parameters

cls	the listen handle
msg	the message

Returns

GNUNET_OK if the message is well-formed

Definition at line 584 of file setu_api.c.

{
  const struct GNUNET_MessageHeader *context_msg;
 
  if (ntohs (msg->header.size) == sizeof(*msg))
    return GNUNET_OK; /* no context message is OK */
  context_msg = GNUNET_MQ_extract_nested_mh (msg);
  if (NULL == context_msg)
  {
    /* malformed context message is NOT ok */
    GNUNET_break_op (0);
    return GNUNET_SYSERR;
  }
  return GNUNET_OK;
}

References GNUNET_break_op, GNUNET_MQ_extract_nested_mh, GNUNET_OK, GNUNET_SYSERR, msg, and GNUNET_MessageHeader::size.

handle_request()

static void handle_request ( void *  cls, const struct GNUNET_SETU_RequestMessage *  msg  )

static

Handle request message for a listen operation.

Parameters

cls	the listen handle
msg	the message

Definition at line 609 of file setu_api.c.

{
  struct GNUNET_SETU_ListenHandle *lh = cls;
  struct GNUNET_SETU_Request req;
  const struct GNUNET_MessageHeader *context_msg;
  struct GNUNET_MQ_Envelope *mqm;
  struct GNUNET_SETU_RejectMessage *rmsg;
 
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "Processing incoming operation request with id %u\n",
       ntohl (msg->accept_id));
  /* we got another valid request => reset the backoff */
  lh->reconnect_backoff = GNUNET_TIME_UNIT_MILLISECONDS;
  req.accept_id = ntohl (msg->accept_id);
  req.accepted = GNUNET_NO;
  context_msg = GNUNET_MQ_extract_nested_mh (msg);
  /* calling #GNUNET_SETU_accept() in the listen cb will set req->accepted */
  lh->listen_cb (lh->listen_cls,
                 &msg->peer_id,
                 context_msg,
                 &req);
  if (GNUNET_YES == req.accepted)
    return; /* the accept-case is handled in #GNUNET_SETU_accept() */
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "Rejected request %u\n",
       ntohl (msg->accept_id));
  mqm = GNUNET_MQ_msg (rmsg,
                       GNUNET_MESSAGE_TYPE_SETU_REJECT);
  rmsg->accept_reject_id = msg->accept_id;
  GNUNET_MQ_send (lh->mq,
                  mqm);
}

References GNUNET_SETU_Request::accept_id, GNUNET_SETU_RejectMessage::accept_reject_id, GNUNET_SETU_Request::accepted, GNUNET_ERROR_TYPE_DEBUG, GNUNET_MESSAGE_TYPE_SETU_REJECT, GNUNET_MQ_extract_nested_mh, GNUNET_MQ_msg, GNUNET_MQ_send(), GNUNET_NO, GNUNET_TIME_UNIT_MILLISECONDS, GNUNET_YES, GNUNET_SETU_ListenHandle::listen_cb, GNUNET_SETU_ListenHandle::listen_cls, LOG, GNUNET_SETU_ListenHandle::mq, msg, and GNUNET_SETU_ListenHandle::reconnect_backoff.

Here is the call graph for this function:

handle_client_listener_error()

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

static

Our connection with the set service encountered an error, re-initialize with exponential back-off.

Parameters

cls	the struct GNUNET_SETU_ListenHandle *
error	reason for the disconnect

Definition at line 652 of file setu_api.c.

{
  struct GNUNET_SETU_ListenHandle *lh = cls;
 
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "Listener broke down (%d), re-connecting\n",
       (int) error);
  GNUNET_MQ_destroy (lh->mq);
  lh->mq = NULL;
  lh->reconnect_task = GNUNET_SCHEDULER_add_delayed (lh->reconnect_backoff,
                                                     &listen_connect,
                                                     lh);
  lh->reconnect_backoff = GNUNET_TIME_STD_BACKOFF (lh->reconnect_backoff);
}

References GNUNET_ERROR_TYPE_DEBUG, GNUNET_MQ_destroy(), GNUNET_SCHEDULER_add_delayed(), GNUNET_TIME_STD_BACKOFF, listen_connect(), LOG, GNUNET_SETU_ListenHandle::mq, GNUNET_SETU_ListenHandle::reconnect_backoff, and GNUNET_SETU_ListenHandle::reconnect_task.

Referenced by listen_connect().

Here is the call graph for this function:

Here is the caller graph for this function: