peerinfo_api.c File Reference

API to access peerinfo service. More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_protocols.h"
#include "peerinfo.h"

Include dependency graph for peerinfo_api.c:

Go to the source code of this file.

Data Structures
struct	GNUNET_PEERINFO_IteratorContext
	Context for an iteration request. More...
struct	GNUNET_PEERINFO_Handle
	Handle to the peerinfo service. More...

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

Functions
static void	reconnect (struct GNUNET_PEERINFO_Handle *h)
	Close the existing connection to PEERINFO and reconnect. More...
struct GNUNET_PEERINFO_Handle *	GNUNET_PEERINFO_connect (const struct GNUNET_CONFIGURATION_Handle *cfg)
	Connect to the peerinfo service. More...
void	GNUNET_PEERINFO_disconnect (struct GNUNET_PEERINFO_Handle *h)
	Disconnect from the peerinfo service. More...
static void	reconnect_task (void *cls)
	Task scheduled to re-try connecting to the peerinfo service. More...
static void	do_reconnect (struct GNUNET_PEERINFO_Handle *h)
	We encountered an error, reconnect to the PEERINFO service. More...
static void	mq_error_handler (void *cls, enum GNUNET_MQ_Error error)
	We got a disconnect after asking regex to do the announcement. More...
static int	check_info (void *cls, const struct InfoMessage *im)
	Function called when we receive an info message. More...
static void	handle_info (void *cls, const struct InfoMessage *im)
	Handle info message. More...
static void	send_ic_request (struct GNUNET_PEERINFO_Handle *h)
	Send the next IC request at the head of the queue. More...
static void	handle_end_iteration (void *cls, const struct GNUNET_MessageHeader *msg)
	Type of a function to call when we receive a message from the service. More...
struct GNUNET_PEERINFO_IteratorContext *	GNUNET_PEERINFO_iterate (struct GNUNET_PEERINFO_Handle *h, int include_friend_only, const struct GNUNET_PeerIdentity *peer, GNUNET_PEERINFO_Processor callback, void *callback_cls)
	Call a method for each known matching host. More...
void	GNUNET_PEERINFO_iterate_cancel (struct GNUNET_PEERINFO_IteratorContext *ic)
	Cancel an iteration over peer information. More...
struct GNUNET_MQ_Envelope *	GNUNET_PEERINFO_add_peer (struct GNUNET_PEERINFO_Handle *h, const struct GNUNET_HELLO_Message *hello, GNUNET_SCHEDULER_TaskCallback cont, void *cont_cls)
	Add a host to the persistent list. More...

Detailed Description

API to access peerinfo service.

Author

Christian Grothoff

Definition in file peerinfo_api.c.

Macro Definition Documentation

LOG

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

Definition at line 31 of file peerinfo_api.c.

Function Documentation

reconnect()

static void reconnect ( struct GNUNET_PEERINFO_Handle *  h )

static

Close the existing connection to PEERINFO and reconnect.

Parameters

h	handle to the service

Definition at line 429 of file peerinfo_api.c.

{
  struct GNUNET_MQ_MessageHandler handlers[] = {
    GNUNET_MQ_hd_var_size (info,
                           GNUNET_MESSAGE_TYPE_PEERINFO_INFO,
                           struct InfoMessage,
                           h),
    GNUNET_MQ_hd_fixed_size (end_iteration,
                             GNUNET_MESSAGE_TYPE_PEERINFO_INFO_END,
                             struct GNUNET_MessageHeader,
                             h),
    GNUNET_MQ_handler_end ()
  };
 
  if (NULL != h->r_task)
  {
    GNUNET_SCHEDULER_cancel (h->r_task);
    h->r_task = NULL;
  }
  if (NULL != h->mq)
  {
    GNUNET_MQ_destroy (h->mq);
    h->mq = NULL;
  }
  h->mq = GNUNET_CLIENT_connect (h->cfg,
                                 "peerinfo",
                                 handlers,
                                 &mq_error_handler,
                                 h);
  if (NULL != h->ic_head)
    send_ic_request (h);
}

References GNUNET_ARM_Handle::cfg, GNUNET_CLIENT_connect(), GNUNET_MESSAGE_TYPE_PEERINFO_INFO, GNUNET_MESSAGE_TYPE_PEERINFO_INFO_END, GNUNET_MQ_destroy(), GNUNET_MQ_handler_end, GNUNET_MQ_hd_fixed_size, GNUNET_MQ_hd_var_size, GNUNET_SCHEDULER_cancel(), h, handlers, info, GNUNET_ARM_Handle::mq, mq_error_handler(), and send_ic_request().

Referenced by GNUNET_PEERINFO_connect(), handle_end_iteration(), and reconnect_task().

Here is the call graph for this function:

Here is the caller graph for this function:

reconnect_task()

static void reconnect_task ( void *  cls )

static

Task scheduled to re-try connecting to the peerinfo service.

Parameters

cls	the struct GNUNET_PEERINFO_Handle *

Definition at line 180 of file peerinfo_api.c.

{
  struct GNUNET_PEERINFO_Handle *h = cls;
 
  h->r_task = NULL;
  reconnect (h);
}

References h, and reconnect().

Referenced by do_reconnect().

Here is the call graph for this function:

Here is the caller graph for this function:

do_reconnect()

static void do_reconnect ( struct GNUNET_PEERINFO_Handle *  h )

static

We encountered an error, reconnect to the PEERINFO service.

Parameters

h	handle to reconnect

Definition at line 195 of file peerinfo_api.c.

{
  struct GNUNET_PEERINFO_IteratorContext *ic = h->ic_head;
 
  GNUNET_MQ_destroy (h->mq);
  h->mq = NULL;
  if (NULL != ic)
  {
    GNUNET_CONTAINER_DLL_remove (h->ic_head,
                                 h->ic_tail,
                                 ic);
    if (NULL != ic->callback)
      ic->callback (ic->callback_cls,
                    NULL,
                    NULL,
                    _ ("Failed to receive response from `PEERINFO' service."));
    GNUNET_free (ic);
  }
  h->r_task = GNUNET_SCHEDULER_add_now (&reconnect_task,
                                        h);
}

References _, GNUNET_PEERINFO_IteratorContext::callback, GNUNET_PEERINFO_IteratorContext::callback_cls, GNUNET_CONTAINER_DLL_remove, GNUNET_free, GNUNET_MQ_destroy(), GNUNET_SCHEDULER_add_now(), h, GNUNET_ARM_Handle::mq, and reconnect_task().

Referenced by mq_error_handler().

Here is the call graph for this function:

Here is the caller graph for this function:

mq_error_handler()

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

static

We got a disconnect after asking regex to do the announcement.

Retry.

Parameters

cls	the struct GNUNET_PEERINFO_Handle to retry
error	error code

Definition at line 226 of file peerinfo_api.c.

{
  struct GNUNET_PEERINFO_Handle *h = cls;
 
  do_reconnect (h);
}

References do_reconnect(), and h.

Referenced by reconnect().

Here is the call graph for this function:

Here is the caller graph for this function:

check_info()

static int check_info ( void *  cls, const struct InfoMessage *  im  )

static

Function called when we receive an info message.

Check it is well-formed.

Parameters

cls	closure
im	message received

Returns

GNUNET_OK if the message is OK

Definition at line 244 of file peerinfo_api.c.

{
  struct GNUNET_PEERINFO_Handle *h = cls;
  struct GNUNET_PEERINFO_IteratorContext *ic = h->ic_head;
  uint16_t ms = ntohs (im->header.size) - sizeof(*im);
 
  if (0 != ntohl (im->reserved))
  {
    GNUNET_break (0);
    return GNUNET_SYSERR;
  }
  if (NULL == ic)
  {
    /* didn't expect a response, bad */
    GNUNET_break (0);
    return GNUNET_SYSERR;
  }
  if ((GNUNET_YES == ic->have_peer) &&
      (0 != GNUNET_memcmp (&ic->peer,
                           &im->peer)))
  {
    /* bogus message (from a different iteration call?); out of sequence! */
    LOG (GNUNET_ERROR_TYPE_ERROR,
         "Received HELLO for peer `%s', expected peer `%s'\n",
         GNUNET_i2s (&im->peer),
         GNUNET_i2s (&ic->peer));
    GNUNET_break (0);
    return GNUNET_SYSERR;
  }
  if (ms > sizeof(struct GNUNET_MessageHeader))
  {
    const struct GNUNET_HELLO_Message *hello;
    struct GNUNET_PeerIdentity id;
 
    hello = (const struct GNUNET_HELLO_Message *) &im[1];
    if (ms != GNUNET_HELLO_size (hello))
    {
      /* malformed message */
      GNUNET_break (0);
      return GNUNET_SYSERR;
    }
    if (GNUNET_OK !=
        GNUNET_HELLO_get_id (hello,
                             &id))
    {
      /* malformed message */
      GNUNET_break (0);
      return GNUNET_SYSERR;
    }
    if (0 != GNUNET_memcmp (&im->peer,
                            &id))
    {
      /* malformed message */
      GNUNET_break (0);
      return GNUNET_SYSERR;
    }
  }
  else if (0 != ms)
  {
    /* malformed message */
    GNUNET_break (0);
    return GNUNET_SYSERR;
  }
  return GNUNET_OK;
}

References GNUNET_break, GNUNET_ERROR_TYPE_ERROR, GNUNET_HELLO_get_id(), GNUNET_HELLO_size(), GNUNET_i2s(), GNUNET_memcmp, GNUNET_OK, GNUNET_SYSERR, GNUNET_YES, h, GNUNET_PEERINFO_IteratorContext::have_peer, InfoMessage::header, id, LOG, InfoMessage::peer, GNUNET_PEERINFO_IteratorContext::peer, InfoMessage::reserved, and GNUNET_MessageHeader::size.

Here is the call graph for this function:

handle_info()

static void handle_info ( void *  cls, const struct InfoMessage *  im  )

static

Handle info message.

Parameters

cls	closure
im	message received

Definition at line 319 of file peerinfo_api.c.

{
  struct GNUNET_PEERINFO_Handle *h = cls;
  struct GNUNET_PEERINFO_IteratorContext *ic = h->ic_head;
  const struct GNUNET_HELLO_Message *hello = NULL;
  uint16_t ms;
 
  ms = ntohs (im->header.size);
  if (ms > sizeof(struct InfoMessage))
    hello = (const struct GNUNET_HELLO_Message *) &im[1];
  if (NULL != ic->callback)
    ic->callback (ic->callback_cls,
                  &im->peer,
                  hello,
                  NULL);
}

References GNUNET_PEERINFO_IteratorContext::callback, GNUNET_PEERINFO_IteratorContext::callback_cls, h, InfoMessage::header, InfoMessage::peer, and GNUNET_MessageHeader::size.

send_ic_request()

static void send_ic_request ( struct GNUNET_PEERINFO_Handle *  h )

static

Send the next IC request at the head of the queue.

Parameters

h

handle

Definition at line 344 of file peerinfo_api.c.

{
  struct GNUNET_PEERINFO_IteratorContext *ic = h->ic_head;
  struct GNUNET_MQ_Envelope *env;
  struct ListAllPeersMessage *lapm;
  struct ListPeerMessage *lpm;
 
  if (NULL == ic)
  {
    GNUNET_break (0);
    return;
  }
  if (NULL == h->mq)
  {
    GNUNET_break (0);
    return;
  }
  if (GNUNET_NO == ic->have_peer)
  {
    LOG (GNUNET_ERROR_TYPE_DEBUG,
         "Requesting list of peers from PEERINFO service\n");
    env = GNUNET_MQ_msg (lapm,
                         GNUNET_MESSAGE_TYPE_PEERINFO_GET_ALL);
    lapm->include_friend_only = htonl (ic->include_friend_only);
  }
  else
  {
    LOG (GNUNET_ERROR_TYPE_DEBUG,
         "Requesting information on peer `%s' from PEERINFO service\n",
         GNUNET_i2s (&ic->peer));
    env = GNUNET_MQ_msg (lpm,
                         GNUNET_MESSAGE_TYPE_PEERINFO_GET);
    lpm->include_friend_only = htonl (ic->include_friend_only);
    lpm->peer = ic->peer;
  }
  GNUNET_MQ_send (h->mq,
                  env);
}

References env, GNUNET_break, GNUNET_ERROR_TYPE_DEBUG, GNUNET_i2s(), GNUNET_MESSAGE_TYPE_PEERINFO_GET, GNUNET_MESSAGE_TYPE_PEERINFO_GET_ALL, GNUNET_MQ_msg, GNUNET_MQ_send(), GNUNET_NO, h, GNUNET_PEERINFO_IteratorContext::have_peer, ListPeerMessage::include_friend_only, ListAllPeersMessage::include_friend_only, GNUNET_PEERINFO_IteratorContext::include_friend_only, LOG, GNUNET_ARM_Handle::mq, ListPeerMessage::peer, and GNUNET_PEERINFO_IteratorContext::peer.

Referenced by GNUNET_PEERINFO_iterate(), handle_end_iteration(), and reconnect().

Here is the call graph for this function:

Here is the caller graph for this function:

handle_end_iteration()

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

static

Type of a function to call when we receive a message from the service.

Call the iterator with the result and (if applicable) continue to receive more messages or trigger processing the next event (if applicable).

Parameters

cls	closure
msg	message received, NULL on timeout or fatal error

Definition at line 394 of file peerinfo_api.c.

{
  struct GNUNET_PEERINFO_Handle *h = cls;
  struct GNUNET_PEERINFO_IteratorContext *ic = h->ic_head;
 
  if (NULL == ic)
  {
    /* didn't expect a response, reconnect */
    GNUNET_break (0);
    reconnect (h);
    return;
  }
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "Received end of list of peers from PEERINFO service\n");
  GNUNET_CONTAINER_DLL_remove (h->ic_head,
                               h->ic_tail,
                               ic);
  if (NULL != h->ic_head)
    send_ic_request (h);
  if (NULL != ic->callback)
    ic->callback (ic->callback_cls,
                  NULL,
                  NULL,
                  NULL);
  GNUNET_free (ic);
}

References GNUNET_PEERINFO_IteratorContext::callback, GNUNET_PEERINFO_IteratorContext::callback_cls, GNUNET_break, GNUNET_CONTAINER_DLL_remove, GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, h, LOG, reconnect(), and send_ic_request().

Here is the call graph for this function: