/*
This file is part of GNUnet
- (C) 2012, 2013 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2012, 2013 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
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., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
*/
/**
- * @file include/gnunet_namestore_service.h
- * @brief API that can be used to store naming information on a GNUnet node;
- * Naming information can either be records for which this peer/user
- * is authoritative, or blocks which are cached, encrypted naming
- * data from other peers.
* @author Christian Grothoff
+ *
+ * @file
+ * API that can be used to store naming information on a GNUnet node;
+ *
+ * @defgroup namestore Name Store service
+ * Store naming information on a GNUnet node.
+ *
+ * Naming information can either be records for which this peer/user is
+ * authoritative, or blocks which are cached, encrypted naming data from other
+ * peers.
+ *
+ * @see [Documentation](https://gnunet.org/namestore-subsystem)
+ *
+ * @{
*/
#ifndef GNUNET_NAMESTORE_SERVICE_H
#define GNUNET_NAMESTORE_SERVICE_H
* #GNUNET_YES (or other positive value) on success
* @param emsg NULL on success, otherwise an error message
*/
-typedef void (*GNUNET_NAMESTORE_ContinuationWithStatus) (void *cls,
- int32_t success,
- const char *emsg);
-
-
-/**
- * Store an item in the namestore. If the item is already present,
- * it is replaced with the new record.
- *
- * @param h handle to the namestore
- * @param block block to store
- * @param cont continuation to call when done
- * @param cont_cls closure for @a cont
- * @return handle to abort the request
- */
-struct GNUNET_NAMESTORE_QueueEntry *
-GNUNET_NAMESTORE_block_cache (struct GNUNET_NAMESTORE_Handle *h,
- const struct GNUNET_GNSRECORD_Block *block,
- GNUNET_NAMESTORE_ContinuationWithStatus cont,
- void *cont_cls);
+typedef void
+(*GNUNET_NAMESTORE_ContinuationWithStatus) (void *cls,
+ int32_t success,
+ const char *emsg);
/**
*
* @param h handle to the namestore
* @param pkey private key of the zone
- * @param label name that is being mapped (at most 255 characters long)
+ * @param label name that is being mapped
* @param rd_count number of records in the 'rd' array
* @param rd array of records with data to store
* @param cont continuation to call when done
void *cont_cls);
+
/**
* Process a record that was stored in the namestore.
*
* @param cls closure
- * @param block block that was stored in the namestore
+ * @param zone private key of the zone; NULL on disconnect
+ * @param label label of the records; NULL on disconnect
+ * @param rd_count number of entries in @a rd array, 0 if label was deleted
+ * @param rd array of records with data to store
*/
-typedef void (*GNUNET_GNSRECORD_BlockProcessor) (void *cls,
- const struct GNUNET_GNSRECORD_Block *block);
+typedef void
+(*GNUNET_NAMESTORE_RecordMonitor) (void *cls,
+ const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
+ const char *label,
+ unsigned int rd_count,
+ const struct GNUNET_GNSRECORD_Data *rd);
/**
- * Get a result for a particular key from the namestore. The processor
- * will only be called once.
+ * Set the desired nick name for a zone
*
* @param h handle to the namestore
- * @param derived_hash hash of zone key combined with name to lookup
- * then at the end once with NULL
- * @param proc function to call on the matching block, or with
- * NULL if there is no matching block
- * @param proc_cls closure for @a proc
- * @return a handle that can be used to cancel
+ * @param pkey private key of the zone
+ * @param nick the nick name to set
+ * @param cont continuation to call when done
+ * @param cont_cls closure for 'cont'
+ * @return handle to abort the request
*/
struct GNUNET_NAMESTORE_QueueEntry *
-GNUNET_NAMESTORE_lookup_block (struct GNUNET_NAMESTORE_Handle *h,
- const struct GNUNET_HashCode *derived_hash,
- GNUNET_GNSRECORD_BlockProcessor proc, void *proc_cls);
+GNUNET_NAMESTORE_set_nick (struct GNUNET_NAMESTORE_Handle *h,
+ const struct GNUNET_CRYPTO_EcdsaPrivateKey *pkey,
+ const char *nick,
+ GNUNET_NAMESTORE_ContinuationWithStatus cont,
+ void *cont_cls);
/**
- * Process a record that was stored in the namestore.
+ * Lookup an item in the namestore.
*
- * @param cls closure
- * @param zone private key of the zone; NULL on disconnect
- * @param label label of the records; NULL on disconnect
- * @param rd_count number of entries in @a rd array, 0 if label was deleted
- * @param rd array of records with data to store
+ * @param h handle to the namestore
+ * @param pkey private key of the zone
+ * @param label name that is being mapped
+ * @param rm function to call with the result (with 0 records if we don't have that label)
+ * @param rm_cls closure for @a rm
+ * @return handle to abort the request
*/
-typedef void (*GNUNET_NAMESTORE_RecordMonitor) (void *cls,
- const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
- const char *label,
- unsigned int rd_count,
- const struct GNUNET_GNSRECORD_Data *rd);
+struct GNUNET_NAMESTORE_QueueEntry *
+GNUNET_NAMESTORE_records_lookup (struct GNUNET_NAMESTORE_Handle *h,
+ const struct GNUNET_CRYPTO_EcdsaPrivateKey *pkey,
+ const char *label,
+ GNUNET_NAMESTORE_RecordMonitor rm,
+ void *rm_cls);
/**
* @param zone zone to access, NULL for all zones
* @param proc function to call on each name from the zone; it
* will be called repeatedly with a value (if available)
- * and always once at the end with a name of NULL.
+ * and always once at the end with a label of NULL.
* @param proc_cls closure for @a proc
* @return an iterator handle to use for iteration
*/
*
* @param cls closure
*/
-typedef void (*GNUNET_NAMESTORE_RecordsSynchronizedCallback)(void *cls);
+typedef void
+(*GNUNET_NAMESTORE_RecordsSynchronizedCallback)(void *cls);
/**
- * Begin monitoring a zone for changes. Will first call the @a monitor function
- * on all existing records in the selected zone(s), then calls @a sync_cb,
- * and then calls the @a monitor whenever a record changes. If the namestore
- * disconnects, the @a monitor function is called with a disconnect event; if
- * the connection is re-established, the process begins from the start (all
- * existing records, sync, then updates).
+ * Begin monitoring a zone for changes. Will first call the @a
+ * monitor function on all existing records in the selected zone(s) if
+ * @a iterate_first is #GNUNET_YES. In any case, we will then call @a
+ * sync_cb, and then afterwards call the @a monitor whenever a record
+ * changes. If the namestore disconnects, the @a monitor function is
+ * called with a disconnect event; if the connection is
+ * re-established, the process begins from the start (depending on @a
+ * iterate_first, we first do all existing records, then @a sync, then
+ * updates).
*
* @param cfg configuration to use to connect to namestore
- * @param zone zone to monitor
+ * @param zone zone to monitor, NULL for all zones
+ * @param iterate_first #GNUNET_YES to first iterate over all existing records,
+ * #GNUNET_NO to only return changes that happen from now on
* @param monitor function to call on zone changes
* @param sync_cb function called when we're in sync with the namestore
* @param cls closure for @a monitor and @a sync_cb
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_NAMESTORE_RecordMonitor monitor,
GNUNET_NAMESTORE_RecordsSynchronizedCallback sync_cb,
void *cls);
GNUNET_NAMESTORE_zone_monitor_stop (struct GNUNET_NAMESTORE_ZoneMonitor *zm);
-
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
}
#endif
-/* end of gnunet_namestore_service.h */
#endif
+
+/** @} */ /* end of group */