/*
This file is part of GNUnet.
- Copyright (C) 2013, 2016 GNUnet e.V.
+ Copyright (C) 2013, 2016, 2018 GNUnet e.V.
- GNUnet is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published
- by the Free Software Foundation; either version 3, or (at your
- option) any later version.
+ GNUnet is free software: you can redistribute it and/or modify it
+ under the terms of the GNU Affero General Public License as published
+ by the Free Software Foundation, either version 3 of the License,
+ or (at your option) any later version.
GNUnet is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License
- along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
- Boston, MA 02110-1301, USA.
+ Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
/**
* @file namestore/namestore_api_monitor.c
* @brief API to monitor changes in the NAMESTORE
*/
struct GNUNET_MQ_Handle *mq;
+ /**
+ * Function to call on errors.
+ */
+ GNUNET_SCHEDULER_TaskCallback error_cb;
+
+ /**
+ * Closure for @e error_cb.
+ */
+ void *error_cb_cls;
+
/**
* Function to call on events.
*/
GNUNET_NAMESTORE_RecordMonitor monitor;
+ /**
+ * Closure for @e monitor.
+ */
+ void *monitor_cls;
+
/**
* Function called when we've synchronized.
*/
- GNUNET_NAMESTORE_RecordsSynchronizedCallback sync_cb;
+ GNUNET_SCHEDULER_TaskCallback sync_cb;
/**
- * Closure for @e monitor and @e sync_cb.
+ * Closure for @e sync_cb.
*/
- void *cls;
+ void *sync_cb_cls;
/**
* Monitored zone.
{
struct GNUNET_NAMESTORE_ZoneMonitor *zm = cls;
+ (void) cls;
+ (void) msg;
if (NULL != zm->sync_cb)
- zm->sync_cb (zm->cls);
+ zm->sync_cb (zm->sync_cb_cls);
}
const char *name_tmp;
const char *rd_ser_tmp;
+ (void) cls;
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;
if (lrm_len != exp_lrm_len)
{
return GNUNET_SYSERR;
}
name_tmp = (const char *) &lrm[1];
- if ((name_tmp[name_len -1] != '\0') || (name_len > MAX_NAME_LEN))
+ if (name_tmp[name_len -1] != '\0')
{
GNUNET_break (0);
return GNUNET_SYSERR;
rd_ser_tmp,
rd_count,
rd));
- zm->monitor (zm->cls,
+ zm->monitor (zm->monitor_cls,
&lrm->private_key,
name_tmp,
rd_count,
{
struct GNUNET_NAMESTORE_ZoneMonitor *zm = cls;
+ (void) error;
reconnect (zm);
}
static void
reconnect (struct GNUNET_NAMESTORE_ZoneMonitor *zm)
{
- GNUNET_MQ_hd_fixed_size (sync,
- GNUNET_MESSAGE_TYPE_NAMESTORE_MONITOR_SYNC,
- struct GNUNET_MessageHeader);
- GNUNET_MQ_hd_var_size (result,
- GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_RESULT,
- struct RecordResultMessage);
struct GNUNET_MQ_MessageHandler handlers[] = {
- make_sync_handler (zm),
- make_result_handler (zm),
+ 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;
if (NULL != zm->mq)
{
GNUNET_MQ_destroy (zm->mq);
- zm->monitor (zm->cls,
- NULL,
- NULL,
- 0,
- NULL);
+ zm->error_cb (zm->error_cb_cls);
}
- zm->mq = GNUNET_CLIENT_connecT (zm->cfg,
+ zm->mq = GNUNET_CLIENT_connect (zm->cfg,
"namestore",
handlers,
&mq_error_handler,
* @param zone zone to monitor
* @param iterate_first #GNUNET_YES to first iterate over all existing records,
* #GNUNET_NO to only return changes that happen from now on
+ * @param error_cb function to call on error (i.e. disconnect); note that
+ * unlike the other error callbacks in this API, a call to this
+ * function does NOT destroy the monitor handle, it merely signals
+ * that monitoring is down. You need to still explicitly call
+ * #GNUNET_NAMESTORE_zone_monitor_stop().
+ * @param error_cb_cls closure for @a error_cb
* @param monitor function to call on zone changes
+ * @param monitor_cls closure for @a monitor
* @param sync_cb function called when we're in sync with the namestore
- * @param cls closure for @a monitor and @a sync_cb
+ * @param cls closure for @a sync_cb
* @return handle to stop monitoring
*/
struct GNUNET_NAMESTORE_ZoneMonitor *
GNUNET_NAMESTORE_zone_monitor_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
int iterate_first,
+ GNUNET_SCHEDULER_TaskCallback error_cb,
+ void *error_cb_cls,
GNUNET_NAMESTORE_RecordMonitor monitor,
- GNUNET_NAMESTORE_RecordsSynchronizedCallback sync_cb,
- void *cls)
+ void *monitor_cls,
+ GNUNET_SCHEDULER_TaskCallback sync_cb,
+ void *sync_cb_cls)
{
struct GNUNET_NAMESTORE_ZoneMonitor *zm;
if (NULL != zone)
zm->zone = *zone;
zm->iterate_first = iterate_first;
+ zm->error_cb = error_cb;
+ zm->error_cb_cls = error_cb_cls;
zm->monitor = monitor;
+ zm->monitor_cls = monitor_cls;
zm->sync_cb = sync_cb;
- zm->cls = cls;
+ zm->sync_cb_cls = sync_cb_cls;
zm->cfg = cfg;
reconnect (zm);
if (NULL == zm->mq)
}
+/**
+ * Calls the monitor processor specified in #GNUNET_NAMESTORE_zone_monitor_start
+ * for the next record(s). This function is used to allow clients that merely
+ * monitor the NAMESTORE to still throttle namestore operations, so we can be
+ * sure that the monitors can keep up.
+ *
+ * Note that #GNUNET_NAMESTORE_records_store() only waits for this
+ * call if the previous limit set by the client was already reached.
+ * Thus, by using a @a limit greater than 1, monitors basically enable
+ * a queue of notifications to be processed asynchronously with some
+ * delay. Note that even with a limit of 1 the
+ * #GNUNET_NAMESTORE_records_store() function will run asynchronously
+ * and the continuation may be invoked before the monitors completed
+ * (or even started) processing the notification. Thus, monitors will
+ * only closely track the current state of the namestore, but not
+ * be involved in the transactions.
+ *
+ * @param zm the monitor
+ * @param limit number of records to return to the iterator in one shot
+ * (before #GNUNET_NAMESTORE_zone_monitor_next is to be called again)
+ */
+void
+GNUNET_NAMESTORE_zone_monitor_next (struct GNUNET_NAMESTORE_ZoneMonitor *zm,
+ uint64_t limit)
+{
+ struct GNUNET_MQ_Envelope *env;
+ struct ZoneMonitorNextMessage *nm;
+
+ env = GNUNET_MQ_msg (nm,
+ GNUNET_MESSAGE_TYPE_NAMESTORE_MONITOR_NEXT);
+ nm->limit = GNUNET_htonll (limit);
+ GNUNET_MQ_send (zm->mq,
+ env);
+}
+
+
/**
* Stop monitoring a zone for changes.
*
projects / oweals / gnunet.git / blobdiff