peerinfo_api_notify.c File Reference

notify API to access peerinfo service More...

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

Include dependency graph for peerinfo_api_notify.c:

Go to the source code of this file.

Data Structures
struct	GNUNET_PEERINFO_NotifyContext
	Context for the info handler. More...

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

Functions
static void	reconnect (void *cls)
	Task to re-try connecting to peerinfo. More...
static void	do_reconnect (struct GNUNET_PEERINFO_NotifyContext *nc)
	We encountered an error, reconnect to the 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_notification (void *cls, const struct InfoMessage *im)
	Check that a peerinfo information message is well-formed. More...
static void	handle_notification (void *cls, const struct InfoMessage *im)
	Receive a peerinfo information message, process it. 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_NotifyContext *	GNUNET_PEERINFO_notify (const struct GNUNET_CONFIGURATION_Handle *cfg, int include_friend_only, GNUNET_PEERINFO_Processor callback, void *callback_cls)
	Call a method whenever our known information about peers changes. More...
void	GNUNET_PEERINFO_notify_cancel (struct GNUNET_PEERINFO_NotifyContext *nc)
	Stop notifying about changes. More...

Detailed Description

notify API to access peerinfo service

Author

Christian Grothoff

Definition in file peerinfo_api_notify.c.

Macro Definition Documentation

LOG

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

Definition at line 32 of file peerinfo_api_notify.c.

Function Documentation

reconnect()

static void reconnect ( void *  cls )

static

Task to re-try connecting to peerinfo.

Parameters

cls	the struct GNUNET_PEERINFO_NotifyContext *

Definition at line 196 of file peerinfo_api_notify.c.

{
  struct GNUNET_PEERINFO_NotifyContext *nc = cls;
  struct GNUNET_MQ_MessageHandler handlers[] = {
    GNUNET_MQ_hd_var_size (notification,
                           GNUNET_MESSAGE_TYPE_PEERINFO_INFO,
                           struct InfoMessage,
                           nc),
    GNUNET_MQ_hd_fixed_size (end_iteration,
                             GNUNET_MESSAGE_TYPE_PEERINFO_INFO_END,
                             struct GNUNET_MessageHeader,
                             nc),
    GNUNET_MQ_handler_end ()
  };
  struct GNUNET_MQ_Envelope *env;
  struct NotifyMessage *nm;
 
  nc->task = NULL;
  nc->mq = GNUNET_CLIENT_connect (nc->cfg,
                                  "peerinfo",
                                  handlers,
                                  &mq_error_handler,
                                  nc);
  if (NULL == nc->mq)
    return;
  env = GNUNET_MQ_msg (nm,
                       GNUNET_MESSAGE_TYPE_PEERINFO_NOTIFY);
  nm->include_friend_only = htonl (nc->include_friend_only);
  GNUNET_MQ_send (nc->mq,
                  env);
}

References GNUNET_PEERINFO_NotifyContext::cfg, env, GNUNET_CLIENT_connect(), GNUNET_MESSAGE_TYPE_PEERINFO_INFO, GNUNET_MESSAGE_TYPE_PEERINFO_INFO_END, GNUNET_MESSAGE_TYPE_PEERINFO_NOTIFY, GNUNET_MQ_handler_end, GNUNET_MQ_hd_fixed_size, GNUNET_MQ_hd_var_size, GNUNET_MQ_msg, GNUNET_MQ_send(), handlers, NotifyMessage::include_friend_only, GNUNET_PEERINFO_NotifyContext::include_friend_only, GNUNET_PEERINFO_NotifyContext::mq, mq_error_handler(), nc, and GNUNET_PEERINFO_NotifyContext::task.

Referenced by do_reconnect(), and GNUNET_PEERINFO_notify().

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_NotifyContext *  nc )

static

We encountered an error, reconnect to the service.

Parameters

nc	context to reconnect

Definition at line 86 of file peerinfo_api_notify.c.

{
  GNUNET_MQ_destroy (nc->mq);
  nc->mq = NULL;
  nc->task = GNUNET_SCHEDULER_add_now (&reconnect,
                                       nc);
}

References GNUNET_MQ_destroy(), GNUNET_SCHEDULER_add_now(), GNUNET_PEERINFO_NotifyContext::mq, nc, reconnect(), and GNUNET_PEERINFO_NotifyContext::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_NotifyContext to retry
error	error code

Definition at line 103 of file peerinfo_api_notify.c.

{
  struct GNUNET_PEERINFO_NotifyContext *nc = cls;
 
  do_reconnect (nc);
}

References do_reconnect(), and nc.

Referenced by reconnect().

Here is the call graph for this function:

Here is the caller graph for this function:

check_notification()

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

static

Check that a peerinfo information message is well-formed.

Parameters

cls	closure
im	message received

Returns

GNUNET_OK if the message is well-formed

Definition at line 120 of file peerinfo_api_notify.c.

{
  uint16_t ms = ntohs (im->header.size) - sizeof(*im);
 
  if (ms >= sizeof(struct GNUNET_MessageHeader))
  {
    const struct GNUNET_HELLO_Message *hello;
 
    hello = (const struct GNUNET_HELLO_Message *) &im[1];
    if (ms != GNUNET_HELLO_size (hello))
    {
      GNUNET_break (0);
      return GNUNET_SYSERR;
    }
    return GNUNET_OK;
  }
  if (0 != ms)
  {
    GNUNET_break (0);
    return GNUNET_SYSERR;
  }
  return GNUNET_OK;  /* odd... */
}

References GNUNET_break, GNUNET_HELLO_size(), GNUNET_OK, GNUNET_SYSERR, InfoMessage::header, and GNUNET_MessageHeader::size.

Here is the call graph for this function:

handle_notification()

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

static

Receive a peerinfo information message, process it.

Parameters

cls	closure
im	message received

Definition at line 153 of file peerinfo_api_notify.c.

{
  struct GNUNET_PEERINFO_NotifyContext *nc = cls;
  const struct GNUNET_HELLO_Message *hello;
  uint16_t ms = ntohs (im->header.size) - sizeof(struct InfoMessage);
 
  if (0 == ms)
    return;
  hello = (const struct GNUNET_HELLO_Message *) &im[1];
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "Received information about peer `%s' from peerinfo database\n",
       GNUNET_i2s (&im->peer));
  nc->callback (nc->callback_cls,
                &im->peer,
                hello,
                NULL);
}

References GNUNET_PEERINFO_NotifyContext::callback, GNUNET_PEERINFO_NotifyContext::callback_cls, GNUNET_ERROR_TYPE_DEBUG, GNUNET_i2s(), InfoMessage::header, LOG, nc, InfoMessage::peer, and GNUNET_MessageHeader::size.

Here is the call 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 183 of file peerinfo_api_notify.c.

{
  /* these are ignored by the notify API */
}