namestore_api_monitor.c File Reference

API to monitor changes in the NAMESTORE. More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_constants.h"
#include "gnunet_arm_service.h"
#include "gnunet_signatures.h"
#include "gnunet_namestore_service.h"
#include "namestore.h"

Include dependency graph for namestore_api_monitor.c:

Go to the source code of this file.

Data Structures
struct	GNUNET_NAMESTORE_ZoneMonitor
	Handle for a monitoring activity. More...

Functions
static void	reconnect (struct GNUNET_NAMESTORE_ZoneMonitor *zm)
	Reconnect to the namestore service. More...
static void	handle_sync (void *cls, const struct GNUNET_MessageHeader *msg)
	Handle SYNC message from the namestore service. More...
static int	check_result (void *cls, const struct RecordResultMessage *lrm)
	We've received a notification about a change to our zone. More...
static void	handle_result (void *cls, const struct RecordResultMessage *lrm)
	We've received a notification about a change to our zone. More...
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. More...
struct GNUNET_NAMESTORE_ZoneMonitor *	GNUNET_NAMESTORE_zone_monitor_start (const struct GNUNET_CONFIGURATION_Handle *cfg, const struct GNUNET_IDENTITY_PrivateKey *zone, int iterate_first, GNUNET_SCHEDULER_TaskCallback error_cb, void *error_cb_cls, GNUNET_NAMESTORE_RecordMonitor monitor, void *monitor_cls, GNUNET_SCHEDULER_TaskCallback sync_cb, void *sync_cb_cls)
struct GNUNET_NAMESTORE_ZoneMonitor *	GNUNET_NAMESTORE_zone_monitor_start2 (const struct GNUNET_CONFIGURATION_Handle *cfg, const struct GNUNET_IDENTITY_PrivateKey *zone, int iterate_first, GNUNET_SCHEDULER_TaskCallback error_cb, void *error_cb_cls, GNUNET_NAMESTORE_RecordSetMonitor monitor, void *monitor_cls, GNUNET_SCHEDULER_TaskCallback sync_cb, void *sync_cb_cls, enum GNUNET_GNSRECORD_Filter filter)
	Begin monitoring a zone for changes. More...
void	GNUNET_NAMESTORE_zone_monitor_next (struct GNUNET_NAMESTORE_ZoneMonitor *zm, uint64_t limit)
	Calls the monitor processor specified in GNUNET_NAMESTORE_zone_monitor_start for the next record(s). More...
void	GNUNET_NAMESTORE_zone_monitor_stop (struct GNUNET_NAMESTORE_ZoneMonitor *zm)
	Stop monitoring a zone for changes. More...

Detailed Description

API to monitor changes in the NAMESTORE.

Author

Christian Grothoff

Definition in file namestore_api_monitor.c.

Function Documentation

reconnect()

static void reconnect ( struct GNUNET_NAMESTORE_ZoneMonitor *  zm )

static

Reconnect to the namestore service.

Parameters

zm	monitor to reconnect

Definition at line 274 of file namestore_api_monitor.c.

{
  struct GNUNET_MQ_MessageHandler handlers[] =
  { GNUNET_MQ_hd_fixed_size (sync,
                             GNUNET_MESSAGE_TYPE_NAMESTORE_MONITOR_SYNC,
                             struct GNUNET_MessageHeader,
                             zm),
    GNUNET_MQ_hd_var_size (result,
                           GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_RESULT,
                           struct RecordResultMessage,
                           zm),
    GNUNET_MQ_handler_end () };
  struct GNUNET_MQ_Envelope *env;
  struct ZoneMonitorStartMessage *sm;
 
  if (NULL != zm->mq)
  {
    GNUNET_MQ_destroy (zm->mq);
    zm->error_cb (zm->error_cb_cls);
  }
  zm->mq = GNUNET_CLIENT_connect (zm->cfg,
                                  "namestore",
                                  handlers,
                                  &mq_error_handler,
                                  zm);
  if (NULL == zm->mq)
    return;
  env = GNUNET_MQ_msg_extra (sm,
                             zm->key_len,
                             GNUNET_MESSAGE_TYPE_NAMESTORE_MONITOR_START);
  sm->iterate_first = htonl (zm->iterate_first);
  if (0 < zm->key_len)
    GNUNET_IDENTITY_write_private_key_to_buffer (&zm->zone,
                                               &sm[1],
                                               zm->key_len);
  sm->key_len = htons (zm->key_len);
  sm->filter = htons (zm->filter);
  GNUNET_MQ_send (zm->mq, env);
}

References GNUNET_NAMESTORE_ZoneMonitor::cfg, env, GNUNET_NAMESTORE_ZoneMonitor::error_cb, GNUNET_NAMESTORE_ZoneMonitor::error_cb_cls, ZoneMonitorStartMessage::filter, GNUNET_NAMESTORE_ZoneMonitor::filter, GNUNET_CLIENT_connect(), GNUNET_IDENTITY_write_private_key_to_buffer(), GNUNET_MESSAGE_TYPE_NAMESTORE_MONITOR_START, GNUNET_MESSAGE_TYPE_NAMESTORE_MONITOR_SYNC, GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_RESULT, GNUNET_MQ_destroy(), GNUNET_MQ_handler_end, GNUNET_MQ_hd_fixed_size, GNUNET_MQ_hd_var_size, GNUNET_MQ_msg_extra, GNUNET_MQ_send(), handlers, ZoneMonitorStartMessage::iterate_first, GNUNET_NAMESTORE_ZoneMonitor::iterate_first, ZoneMonitorStartMessage::key_len, GNUNET_NAMESTORE_ZoneMonitor::key_len, GNUNET_NAMESTORE_ZoneMonitor::mq, mq_error_handler(), result, zm, and GNUNET_NAMESTORE_ZoneMonitor::zone.

Referenced by GNUNET_NAMESTORE_zone_monitor_start(), GNUNET_NAMESTORE_zone_monitor_start2(), and mq_error_handler().

Here is the call graph for this function:

Here is the caller graph for this function:

handle_sync()

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

static

Handle SYNC message from the namestore service.

Parameters

cls	the monitor
msg	the sync message

Definition at line 123 of file namestore_api_monitor.c.

{
  struct GNUNET_NAMESTORE_ZoneMonitor *zm = cls;
 
  (void) cls;
  (void) msg;
  if (NULL != zm->sync_cb)
    zm->sync_cb (zm->sync_cb_cls);
}

References msg, GNUNET_NAMESTORE_ZoneMonitor::sync_cb, GNUNET_NAMESTORE_ZoneMonitor::sync_cb_cls, and zm.

check_result()

static int check_result ( void *  cls, const struct RecordResultMessage *  lrm  )

static

We've received a notification about a change to our zone.

Check that it is well-formed.

Parameters

cls	the zone monitor handle
lrm	the message from the service.

Definition at line 142 of file namestore_api_monitor.c.

{
  struct GNUNET_NAMESTORE_ZoneMonitor *zm = cls;
  size_t lrm_len;
  size_t exp_lrm_len;
  size_t name_len;
  size_t rd_len;
  unsigned rd_count;
  const char *name_tmp;
  const char *rd_ser_tmp;
  size_t key_len;
 
  (void) zm;
  key_len = ntohs (lrm->key_len);
  (void) cls;
  if (0 == key_len)
  {
    GNUNET_break (0);
    return GNUNET_SYSERR;
  }
  lrm_len = ntohs (lrm->gns_header.header.size);
  rd_len = ntohs (lrm->rd_len);
  rd_count = ntohs (lrm->rd_count);
  name_len = ntohs (lrm->name_len);
  if (name_len > MAX_NAME_LEN)
  {
    GNUNET_break (0);
    return GNUNET_SYSERR;
  }
  exp_lrm_len = sizeof(struct RecordResultMessage) + name_len + rd_len + key_len;
  if (lrm_len != exp_lrm_len)
  {
    GNUNET_break (0);
    return GNUNET_SYSERR;
  }
  if (0 == name_len)
  {
    GNUNET_break (0);
    return GNUNET_SYSERR;
  }
  name_tmp = (const char *) &lrm[1] + key_len;
  if (name_tmp[name_len - 1] != '\0')
  {
    GNUNET_break (0);
    return GNUNET_SYSERR;
  }
  rd_ser_tmp = (const char *) &name_tmp[name_len];
  {
    struct GNUNET_GNSRECORD_Data rd[rd_count];
 
    if (GNUNET_OK !=
        GNUNET_GNSRECORD_records_deserialize (rd_len, rd_ser_tmp, rd_count, rd))
    {
      GNUNET_break (0);
      return GNUNET_SYSERR;
    }
  }
  return GNUNET_OK;
}

References RecordResultMessage::gns_header, GNUNET_break, GNUNET_GNSRECORD_records_deserialize(), GNUNET_OK, GNUNET_SYSERR, GNUNET_NAMESTORE_Header::header, RecordResultMessage::key_len, GNUNET_NAMESTORE_ZoneMonitor::key_len, MAX_NAME_LEN, RecordResultMessage::name_len, rd, rd_count, RecordResultMessage::rd_count, RecordResultMessage::rd_len, GNUNET_MessageHeader::size, and zm.

Here is the call graph for this function:

handle_result()

static void handle_result ( void *  cls, const struct RecordResultMessage *  lrm  )

static

We've received a notification about a change to our zone.

Forward to monitor callback.

Parameters

cls	the zone monitor handle
lrm	the message from the service.

Definition at line 211 of file namestore_api_monitor.c.

{
  struct GNUNET_NAMESTORE_ZoneMonitor *zm = cls;
  struct GNUNET_IDENTITY_PrivateKey private_key;
  size_t name_len;
  size_t rd_len;
  size_t key_len;
  size_t kbytes_read;
  unsigned rd_count;
  const char *name_tmp;
  const char *rd_ser_tmp;
 
  key_len = ntohs (lrm->key_len);
  rd_len = ntohs (lrm->rd_len);
  rd_count = ntohs (lrm->rd_count);
  name_len = ntohs (lrm->name_len);
  name_tmp = (const char *) &lrm[1] + key_len;
  GNUNET_assert (GNUNET_SYSERR !=
                 GNUNET_IDENTITY_read_private_key_from_buffer (&lrm[1],
                                                               key_len,
                                                               &private_key,
                                                               &kbytes_read));
  GNUNET_assert (kbytes_read == key_len);
  rd_ser_tmp = (const char *) &name_tmp[name_len];
  {
    struct GNUNET_GNSRECORD_Data rd[rd_count];
 
    GNUNET_assert (
      GNUNET_OK ==
      GNUNET_GNSRECORD_records_deserialize (rd_len, rd_ser_tmp, rd_count, rd));
    if (NULL != zm->monitor2)
      zm->monitor2 (zm->monitor_cls, &private_key, name_tmp,
                    rd_count, rd, GNUNET_TIME_absolute_ntoh (lrm->expire));
    else
      zm->monitor (zm->monitor_cls, &private_key, name_tmp, rd_count, rd);
  }
}

References RecordResultMessage::expire, GNUNET_assert, GNUNET_GNSRECORD_records_deserialize(), GNUNET_IDENTITY_read_private_key_from_buffer(), GNUNET_OK, GNUNET_SYSERR, GNUNET_TIME_absolute_ntoh(), RecordResultMessage::key_len, GNUNET_NAMESTORE_ZoneMonitor::monitor, GNUNET_NAMESTORE_ZoneMonitor::monitor2, GNUNET_NAMESTORE_ZoneMonitor::monitor_cls, RecordResultMessage::name_len, rd, rd_count, RecordResultMessage::rd_count, RecordResultMessage::rd_len, and zm.

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 with the struct GNUNET_NAMESTORE_ZoneMonitor *
error	error code

Definition at line 259 of file namestore_api_monitor.c.

{
  struct GNUNET_NAMESTORE_ZoneMonitor *zm = cls;
 
  (void) error;
  reconnect (zm);
}

References reconnect(), and zm.

Referenced by reconnect().

Here is the call graph for this function:

Here is the caller graph for this function: