X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_namestore_service.h;h=9b6beef28049c72d7cb774db84939e8fbef94dd5;hb=6e626937fd5133188d2bd06f280a1b889219eef2;hp=3966c3db29d13d95a1c9d73f5e16fbea29003422;hpb=c8b184df65f4ce954ab571a2a174db3ea0d5c1d6;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_namestore_service.h b/src/include/gnunet_namestore_service.h index 3966c3db2..9b6beef28 100644 --- a/src/include/gnunet_namestore_service.h +++ b/src/include/gnunet_namestore_service.h @@ -1,37 +1,46 @@ /* This file is part of GNUnet - (C) 2012, 2013 Christian Grothoff (and other contributing authors) + Copyright (C) 2012, 2013, 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. + 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 . - 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. + SPDX-License-Identifier: AGPL3.0-or-later */ /** - * @file include/gnunet_namestore_service.h - * @brief API that can be used to store naming information on a GNUnet node; * @author Christian Grothoff * - * Other functions we might want: - * - enumerate all known zones + * @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 #include "gnunet_util_lib.h" #include "gnunet_block_lib.h" +#include "gnunet_gnsrecord_lib.h" #ifdef __cplusplus extern "C" @@ -41,35 +50,6 @@ extern "C" #endif #endif -/** - * Record type indicating any record/'*' - */ -#define GNUNET_NAMESTORE_TYPE_ANY 0 - -/** - * Record type for GNS zone transfer ("PKEY"). - */ -#define GNUNET_NAMESTORE_TYPE_PKEY 65536 - -/** - * Record type for GNS zone transfer ("PSEU"). - */ -#define GNUNET_NAMESTORE_TYPE_PSEU 65537 - -/** - * Record type for GNS legacy hostnames ("LEHO"). - */ -#define GNUNET_NAMESTORE_TYPE_LEHO 65538 - -/** - * Record type for VPN resolution - */ -#define GNUNET_NAMESTORE_TYPE_VPN 65539 - -/** - * Record type for zone revocation - */ -#define GNUNET_NAMESTORE_TYPE_REV 65540 /** * Entry in the queue. @@ -86,12 +66,6 @@ struct GNUNET_NAMESTORE_Handle; */ struct GNUNET_NAMESTORE_ZoneIterator; -/** - * Maximum size of a value that can be stored in the namestore. - */ -#define GNUNET_NAMESTORE_MAX_VALUE_SIZE (63 * 1024) - - /** * Connect to the namestore service. @@ -105,7 +79,8 @@ GNUNET_NAMESTORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg); /** * Disconnect from the namestore service (and free associated - * resources). + * resources). Must not be called from within operation callbacks of + * the API. * * @param h handle to the namestore */ @@ -118,109 +93,15 @@ GNUNET_NAMESTORE_disconnect (struct GNUNET_NAMESTORE_Handle *h); * operation. * * @param cls closure - * @param success GNUNET_SYSERR on failure (including timeout/queue drop/failure to validate) - * GNUNET_NO if content was already there or not found - * GNUNET_YES (or other positive value) on success + * @param success #GNUNET_SYSERR on failure (including timeout/queue drop/failure to validate) + * #GNUNET_NO if content was already there or not found + * #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); - - -/** - * Flags that can be set for a record. - */ -enum GNUNET_NAMESTORE_RecordFlags -{ - - /** - * No special options. - */ - GNUNET_NAMESTORE_RF_NONE = 0, - - /** - * This peer is the authority for this record; it must thus - * not be deleted (other records can be deleted if we run - * out of space). - */ - GNUNET_NAMESTORE_RF_AUTHORITY = 1, - - /** - * This is a private record of this peer and it should - * thus not be handed out to other peers. - */ - GNUNET_NAMESTORE_RF_PRIVATE = 2, - - /** - * This record was added by the system - * and is pending user confimation - */ - GNUNET_NAMESTORE_RF_PENDING = 4, - - /** - * This expiration time of the record is a relative - * time (not an absolute time). - */ - GNUNET_NAMESTORE_RF_RELATIVE_EXPIRATION = 8, - - /** - * This record should not be used unless all (other) records with an absolute - * expiration time have expired. - */ - GNUNET_NAMESTORE_RF_SHADOW_RECORD = 16 - - /** - * When comparing flags for record equality for removal, - * which flags should must match (in addition to the type, - * name, expiration value and data of the record)? All flags - * that are not listed here will be ignored for this purpose. - * (for example, we don't expect that users will remember to - * pass the '--private' option when removing a record from - * the namestore, hence we don't require this particular option - * to match upon removal). See also - * 'GNUNET_NAMESTORE_records_cmp'. - */ -#define GNUNET_NAMESTORE_RF_RCMP_FLAGS (GNUNET_NAMESTORE_RF_RELATIVE_EXPIRATION) -}; - - -/** - * A GNS record. - */ -struct GNUNET_NAMESTORE_RecordData -{ - - /** - * Binary value stored in the DNS record. - * FIXME: goofy API: sometimes 'data' is individually - * 'malloc'ed, sometimes it points into some existing - * data area (so sometimes this should be a 'void *', - * sometimes a 'const void *'). This is unclean. - */ - const void *data; - - /** - * Expiration time for the DNS record. Can be relative - * or absolute, depending on 'flags'. - */ - uint64_t expiration_time; - - /** - * Number of bytes in 'data'. - */ - size_t data_size; - - /** - * Type of the GNS/DNS record. - */ - uint32_t record_type; - - /** - * Flags for the record. - */ - enum GNUNET_NAMESTORE_RecordFlags flags; -}; +typedef void +(*GNUNET_NAMESTORE_ContinuationWithStatus) (void *cls, + int32_t success, + const char *emsg); /** @@ -228,127 +109,88 @@ struct GNUNET_NAMESTORE_RecordData * it is replaced with the new record. Use an empty array to * remove all records under the given name. * + * The continuation is called after the value has been stored in the + * database. Monitors may be notified asynchronously (basically with + * a buffer). However, if any monitor is consistently too slow to + * keep up with the changes, calling @a cont will be delayed until the + * monitors do keep up. + * * @param h handle to the namestore - * @param zone_key public key of the zone - * @param name name that is being mapped (at most 255 characters long) - * @param freshness when does the corresponding block in the DHT expire (until - * when should we never do a DHT lookup for the same name again)? - * @param rd_count number of entries in 'rd' array + * @param pkey private key of the zone + * @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 signature signature for all the records in the zone under the given name * @param cont continuation to call when done - * @param cont_cls closure for cont + * @param cont_cls closure for @a cont * @return handle to abort the request */ struct GNUNET_NAMESTORE_QueueEntry * -GNUNET_NAMESTORE_record_put (struct GNUNET_NAMESTORE_Handle *h, - const struct GNUNET_CRYPTO_EccPublicKeyBinaryEncoded *zone_key, - const char *name, - struct GNUNET_TIME_Absolute freshness, - unsigned int rd_count, - const struct GNUNET_NAMESTORE_RecordData *rd, - const struct GNUNET_CRYPTO_EccSignature *signature, - GNUNET_NAMESTORE_ContinuationWithStatus cont, - void *cont_cls); +GNUNET_NAMESTORE_records_store (struct GNUNET_NAMESTORE_Handle *h, + const struct GNUNET_CRYPTO_EcdsaPrivateKey *pkey, + const char *label, + unsigned int rd_count, + const struct GNUNET_GNSRECORD_Data *rd, + GNUNET_NAMESTORE_ContinuationWithStatus cont, + void *cont_cls); /** - * Check if a signature is valid. This API is used by the GNS Block - * to validate signatures received from the network. + * Process a record that was stored in the namestore. * - * @param public_key public key of the zone - * @param freshness time set for block expiration - * @param name name that is being mapped (at most 255 characters long) - * @param rd_count number of entries in 'rd' array + * @param cls closure + * @param zone private key of the zone + * @param label label of the records + * @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 signature signature for all the records in the zone under the given name - * @return GNUNET_OK if the signature is valid */ -int -GNUNET_NAMESTORE_verify_signature (const struct GNUNET_CRYPTO_EccPublicKeyBinaryEncoded *public_key, - const struct GNUNET_TIME_Absolute freshness, - const char *name, +typedef void +(*GNUNET_NAMESTORE_RecordMonitor) (void *cls, + const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone, + const char *label, unsigned int rd_count, - const struct GNUNET_NAMESTORE_RecordData *rd, - const struct GNUNET_CRYPTO_EccSignature *signature); + const struct GNUNET_GNSRECORD_Data *rd); /** - * Store an item in the namestore. If the item is already present, - * it is replaced with the new record. Use an empty array to - * remove all records under the given name. + * Set the desired nick name for a zone * * @param h handle to the namestore * @param pkey private key of the zone - * @param name name that is being mapped (at most 255 characters long) - * @param rd_count number of records in the 'rd' array - * @param rd array of records with data to store + * @param nick the nick name to set * @param cont continuation to call when done - * @param cont_cls closure for 'cont' + * @param cont_cls closure for @a cont * @return handle to abort the request */ struct GNUNET_NAMESTORE_QueueEntry * -GNUNET_NAMESTORE_record_put_by_authority (struct GNUNET_NAMESTORE_Handle *h, - const struct GNUNET_CRYPTO_EccPrivateKey *pkey, - const char *name, - unsigned int rd_count, - const struct GNUNET_NAMESTORE_RecordData *rd, - GNUNET_NAMESTORE_ContinuationWithStatus cont, - void *cont_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. - * - * @param cls closure - * @param zone_key public key of the zone - * @param freshness when does the corresponding block in the DHT expire (until - * when should we never do a DHT lookup for the same name again)?; - * GNUNET_TIME_UNIT_ZERO_ABS if there are no records of any type in the namestore, - * or the expiration time of the block in the namestore (even if there are zero - * records matching the desired record type) - * @param name name that is being mapped (at most 255 characters long) - * @param rd_count number of entries in 'rd' array - * @param rd array of records with data to store - * @param signature signature of the record block, NULL if signature is unavailable (i.e. - * because the user queried for a particular record type only) - */ -typedef void (*GNUNET_NAMESTORE_RecordProcessor) (void *cls, - const struct GNUNET_CRYPTO_EccPublicKeyBinaryEncoded *zone_key, - struct GNUNET_TIME_Absolute freshness, - const char *name, - unsigned int rd_count, - const struct GNUNET_NAMESTORE_RecordData *rd, - const struct GNUNET_CRYPTO_EccSignature *signature); - - -/** - * Get a result for a particular key from the namestore. The processor - * will only be called once. When using this functions, relative expiration - * times will be converted to absolute expiration times and a signature - * will be created if we are the authority. The record data and signature - * passed to 'proc' is thus always suitable for passing on to other peers - * (if we are the authority). If the record type is NOT set to 'ANY' and - * if we are NOT the authority, then non-matching records may be omitted - * from the result and no valid signature can be created; in this case, - * 'signature' will be NULL and the result cannot be given to other peers. + * Lookup an item in the namestore. * * @param h handle to the namestore - * @param zone zone to look up a record from - * @param name name to look up - * @param record_type desired record type, 0 for all - * @param proc function to call on the matching records, or with - * NULL (rd_count == 0) if there are no matching records - * @param proc_cls closure for proc - * @return a handle that can be used to - * cancel + * @param pkey private key of the zone + * @param label name that is being mapped + * @param error_cb function to call on error (i.e. disconnect) + * the handle is afterwards invalid + * @param error_cb_cls closure for @a error_cb + * @param rm function to call with the result (with 0 records if we don't have that label); + * the handle is afterwards invalid + * @param rm_cls closure for @a rm + * @return handle to abort the request */ struct GNUNET_NAMESTORE_QueueEntry * -GNUNET_NAMESTORE_lookup_record (struct GNUNET_NAMESTORE_Handle *h, - const struct GNUNET_CRYPTO_ShortHashCode *zone, - const char *name, - uint32_t record_type, - GNUNET_NAMESTORE_RecordProcessor proc, void *proc_cls); +GNUNET_NAMESTORE_records_lookup (struct GNUNET_NAMESTORE_Handle *h, + const struct GNUNET_CRYPTO_EcdsaPrivateKey *pkey, + const char *label, + GNUNET_SCHEDULER_TaskCallback error_cb, + void *error_cb_cls, + GNUNET_NAMESTORE_RecordMonitor rm, + void *rm_cls); /** @@ -356,26 +198,33 @@ GNUNET_NAMESTORE_lookup_record (struct GNUNET_NAMESTORE_Handle *h, * Returns at most one result to the processor. * * @param h handle to the namestore - * @param zone hash of public key of the zone to look up in, never NULL - * @param value_zone hash of the public key of the target zone (value), never NULL + * @param zone private key of the zone to look up in, never NULL + * @param value_zone public key of the target zone (value), never NULL + * @param error_cb function to call on error (i.e. disconnect) + * the handle is afterwards invalid + * @param error_cb_cls closure for @a error_cb * @param proc function to call on the matching records, or with - * NULL (rd_count == 0) if there are no matching records - * @param proc_cls closure for proc + * NULL (rd_count == 0) if there are no matching records; + * the handle is afterwards invalid + * @param proc_cls closure for @a proc * @return a handle that can be used to * cancel */ struct GNUNET_NAMESTORE_QueueEntry * -GNUNET_NAMESTORE_zone_to_name (struct GNUNET_NAMESTORE_Handle *h, - const struct GNUNET_CRYPTO_ShortHashCode *zone, - const struct GNUNET_CRYPTO_ShortHashCode *value_zone, - GNUNET_NAMESTORE_RecordProcessor proc, void *proc_cls); +GNUNET_NAMESTORE_zone_to_name (struct GNUNET_NAMESTORE_Handle *h, + const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone, + const struct GNUNET_CRYPTO_EcdsaPublicKey *value_zone, + GNUNET_SCHEDULER_TaskCallback error_cb, + void *error_cb_cls, + GNUNET_NAMESTORE_RecordMonitor proc, + void *proc_cls); /** * Cancel a namestore operation. The final callback from the * operation must not have been done yet. Must be called on any * namestore operation that has not yet completed prior to calling - * 'GNUNET_NAMESTORE_disconnect'. + * #GNUNET_NAMESTORE_disconnect. * * @param qe operation to cancel */ @@ -385,62 +234,57 @@ GNUNET_NAMESTORE_cancel (struct GNUNET_NAMESTORE_QueueEntry *qe); /** * Starts a new zone iteration (used to periodically PUT all of our - * records into our DHT). "proc" will be called once immediately, and - * then again after "GNUNET_NAMESTORE_zone_iterator_next" is invoked. - * - * By specifying a 'zone' of NULL and setting 'GNUNET_NAMESTORE_RF_AUTHORITY' - * in 'must_have_flags', we can iterate over all records for which we are - * the authority (the 'authority' flag will NOT be set in the returned - * records anyway). - * - * The 'GNUNET_NAMESTORE_RF_RELATIVE_EXPIRATION' - * bit in 'must_have_flags' has a special meaning: - * - * 0) If the bit is clear, all relative expriation times are converted to - * absolute expiration times. This is useful for performing DHT PUT - * operations (and zone transfers) of our zone. The generated signatures - * will be valid for other peers. - * 1) if it is set, it means that relative expiration times should be - * preserved when returned (this is useful for the zone editor user - * interface). No signatures will be created in this case, as - * signatures must not cover records with relative expiration times. + * records into our DHT). This MUST lock the `struct GNUNET_NAMESTORE_Handle` + * for any other calls than #GNUNET_NAMESTORE_zone_iterator_next() and + * #GNUNET_NAMESTORE_zone_iteration_stop. @a proc will be called once + * immediately, and then again after + * #GNUNET_NAMESTORE_zone_iterator_next() is invoked. * - * Note that not all queries against this interface are equally performant - * as for some combinations no efficient index may exist. + * On error (disconnect), @a error_cb will be invoked. + * On normal completion, @a finish_cb proc will be + * invoked. * * @param h handle to the namestore * @param zone zone to access, NULL for all zones - * @param must_have_flags flags that must be set for the record to be returned - * @param must_not_have_flags flags that must NOT be set for the record to be returned + * @param error_cb function to call on error (i.e. disconnect), + * the handle is afterwards invalid + * @param error_cb_cls closure for @a error_cb * @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. - * @param proc_cls closure for proc + * @param proc_cls closure for @a proc + * @param finish_cb function to call on completion + * the handle is afterwards invalid + * @param finish_cb_cls closure for @a finish_cb * @return an iterator handle to use for iteration */ struct GNUNET_NAMESTORE_ZoneIterator * GNUNET_NAMESTORE_zone_iteration_start (struct GNUNET_NAMESTORE_Handle *h, - const struct GNUNET_CRYPTO_ShortHashCode *zone, - enum GNUNET_NAMESTORE_RecordFlags must_have_flags, - enum GNUNET_NAMESTORE_RecordFlags must_not_have_flags, - GNUNET_NAMESTORE_RecordProcessor proc, - void *proc_cls); + const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone, + GNUNET_SCHEDULER_TaskCallback error_cb, + void *error_cb_cls, + GNUNET_NAMESTORE_RecordMonitor proc, + void *proc_cls, + GNUNET_SCHEDULER_TaskCallback finish_cb, + void *finish_cb_cls); /** - * Calls the record processor specified in GNUNET_NAMESTORE_zone_iteration_start + * Calls the record processor specified in #GNUNET_NAMESTORE_zone_iteration_start * for the next record. * * @param it the iterator + * @param limit number of records to return to the iterator in one shot + * (before #GNUNET_NAMESTORE_zone_iterator_next is to be called again) */ void -GNUNET_NAMESTORE_zone_iterator_next (struct GNUNET_NAMESTORE_ZoneIterator *it); +GNUNET_NAMESTORE_zone_iterator_next (struct GNUNET_NAMESTORE_ZoneIterator *it, + uint64_t limit); /** * Stops iteration and releases the namestore handle for further calls. Must * be called on any iteration that has not yet completed prior to calling - * 'GNUNET_NAMESTORE_disconnect'. + * #GNUNET_NAMESTORE_disconnect. * * @param it the iterator */ @@ -455,227 +299,77 @@ struct GNUNET_NAMESTORE_ZoneMonitor; /** - * Function called whenever the records for a given name changed. - * - * @param cls closure - * @param zone_key NULL if the communication with the namestore broke down - * (and thus all entries should be 'cleared' until the communication - * can be re-established, at which point the monitor will - * re-add all records that are (still) in the namestore after - * the reconnect); if this value is NULL, all other arguments - * will also be 0/NULL. - * @param freshness when does the corresponding block in the DHT expire (until - * when should we never do a DHT lookup for the same name again)?; - * GNUNET_TIME_UNIT_ZERO_ABS if there are no records of any type in the namestore, - * or the expiration time of the block in the namestore (even if there are zero - * records matching the desired record type) - * @param name name that is being mapped (at most 255 characters long) - * @param rd_count number of entries in 'rd' array - * @param rd array of records with data to store - * @param signature signature of the record block - */ -typedef void (*GNUNET_NAMESTORE_RecordMonitor)(void *cls, - const struct GNUNET_CRYPTO_EccPublicKeyBinaryEncoded *zone_key, - struct GNUNET_TIME_Absolute freshness, - const char *name, - unsigned int rd_len, - const struct GNUNET_NAMESTORE_RecordData *rd, - const struct GNUNET_CRYPTO_EccSignature *signature); - - -/** - * Begin monitoring a zone for changes. Will first call the 'monitor' function - * on all existing records in the selected zone(s) and then call it whenever - * a record changes. + * 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 error_cb function is + * called with a disconnect event. Once the connection is + * re-established, the process begins from the start (depending on @a + * iterate_first, we will again first do all existing records, then @a + * sync, then updates). * * @param cfg configuration to use to connect to namestore * @param zone zone to monitor, NULL for all zones - * @param monitor function to call on zone changes - * @param monitor_cls closure for '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, with an initial limit of 1 + * @param monitor_cls closure for @a monitor + * @param sync_cb function called when we're in sync with the namestore + * @param sync_cb_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_ShortHashCode *zone, + const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone, + int iterate_first, + GNUNET_SCHEDULER_TaskCallback error_cb, + void *error_cb_cls, GNUNET_NAMESTORE_RecordMonitor monitor, - void *monitor_cls); + void *monitor_cls, + GNUNET_SCHEDULER_TaskCallback sync_cb, + void *sync_cb_cls); /** - * Stop monitoring a zone for changes. + * 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. * - * @param zm handle to the monitor activity to stop - */ -void -GNUNET_NAMESTORE_zone_monitor_stop (struct GNUNET_NAMESTORE_ZoneMonitor *zm); - - -/* convenience APIs for serializing / deserializing GNS records */ - -/** - * Calculate how many bytes we will need to serialize the given - * records. - * - * @param rd_count number of records in the rd array - * @param rd array of GNUNET_NAMESTORE_RecordData with rd_count elements - * - * @return the required size to serialize - * - */ -size_t -GNUNET_NAMESTORE_records_get_size (unsigned int rd_count, - const struct GNUNET_NAMESTORE_RecordData *rd); - - -/** - * Serialize the given records to the given destination buffer. - * - * @param rd_count number of records in the rd array - * @param rd array of GNUNET_NAMESTORE_RecordData with rd_count elements - * @param dest_size size of the destination array - * @param dest where to write the result - * - * @return the size of serialized records, -1 if records do not fit - */ -ssize_t -GNUNET_NAMESTORE_records_serialize (unsigned int rd_count, - const struct GNUNET_NAMESTORE_RecordData *rd, - size_t dest_size, - char *dest); - - -/** - * Deserialize the given records to the given destination. - * - * @param len size of the serialized record data - * @param src the serialized record data - * @param rd_count number of records in the rd array - * @param dest where to put the data - * - * @return GNUNET_OK on success, GNUNET_SYSERR on error - */ -int -GNUNET_NAMESTORE_records_deserialize (size_t len, - const char *src, - unsigned int rd_count, - struct GNUNET_NAMESTORE_RecordData *dest); - - -/** - * Convert the 'value' of a record to a string. - * - * @param type type of the record - * @param data value in binary encoding - * @param data_size number of bytes in data - * @return NULL on error, otherwise human-readable representation of the value - */ -char * -GNUNET_NAMESTORE_value_to_string (uint32_t type, - const void *data, - size_t data_size); - - -/** - * Convert human-readable version of a 'value' of a record to the binary - * representation. - * - * @param type type of the record - * @param s human-readable string - * @param data set to value in binary encoding (will be allocated) - * @param data_size set to number of bytes in data - * @return GNUNET_OK on success - */ -int -GNUNET_NAMESTORE_string_to_value (uint32_t type, - const char *s, - void **data, - size_t *data_size); - - -/** - * Convert a type name (i.e. "AAAA") to the corresponding number. + * 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 typename name to convert - * @return corresponding number, UINT32_MAX on error - */ -uint32_t -GNUNET_NAMESTORE_typename_to_number (const char *typename); - - -/** - * Convert a type number (i.e. 1) to the corresponding type string (i.e. "A") - * - * @param type number of a type to convert - * @return corresponding typestring, NULL on error - */ -const char * -GNUNET_NAMESTORE_number_to_typename (uint32_t type); - - -/** - * Test if a given record is expired. - * - * @param rd record to test - * @return GNUNET_YES if the record is expired, - * GNUNET_NO if not + * @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) */ -int -GNUNET_NAMESTORE_is_expired (const struct GNUNET_NAMESTORE_RecordData *rd); - - -/** - * Convert a UTF-8 string to UTF-8 lowercase - * @param src source string - * @return converted result - */ -char * -GNUNET_NAMESTORE_normalize_string (const char *src); - - -/** - * Convert a short hash to a string (for printing debug messages). - * This is one of the very few calls in the entire API that is - * NOT reentrant! - * - * @param hc the short hash code - * @return string form; will be overwritten by next call to GNUNET_h2s. - */ -const char * -GNUNET_NAMESTORE_short_h2s (const struct GNUNET_CRYPTO_ShortHashCode * hc); - - -/** - * Sign name and records - * - * @param key the private key - * @param expire block expiration - * @param name the name - * @param rd record data - * @param rd_count number of records - * - * @return the signature - */ -struct GNUNET_CRYPTO_EccSignature * -GNUNET_NAMESTORE_create_signature (const struct GNUNET_CRYPTO_EccPrivateKey *key, - struct GNUNET_TIME_Absolute expire, - const char *name, - const struct GNUNET_NAMESTORE_RecordData *rd, - unsigned int rd_count); +void +GNUNET_NAMESTORE_zone_monitor_next (struct GNUNET_NAMESTORE_ZoneMonitor *zm, + uint64_t limit); /** - * Compares if two records are equal - * - * @param a Record a - * @param b Record b + * Stop monitoring a zone for changes. * - * @return GNUNET_YES or GNUNET_NO + * @param zm handle to the monitor activity to stop */ -int -GNUNET_NAMESTORE_records_cmp (const struct GNUNET_NAMESTORE_RecordData *a, - const struct GNUNET_NAMESTORE_RecordData *b); - - +void +GNUNET_NAMESTORE_zone_monitor_stop (struct GNUNET_NAMESTORE_ZoneMonitor *zm); #if 0 /* keep Emacsens' auto-indent happy */ @@ -685,5 +379,6 @@ GNUNET_NAMESTORE_records_cmp (const struct GNUNET_NAMESTORE_RecordData *a, } #endif -/* end of gnunet_namestore_service.h */ #endif + +/** @} */ /* end of group */