X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_namestore_plugin.h;h=3b603b4c0b3c98103109db87cee8e251cddeb54f;hb=6e626937fd5133188d2bd06f280a1b889219eef2;hp=5c7408eec315ee5331c3d8a13d35ddd8bf99d191;hpb=9351b1e9bdf2b067b6db06562c26ba658cff42b8;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_namestore_plugin.h b/src/include/gnunet_namestore_plugin.h index 5c7408eec..3b603b4c0 100644 --- a/src/include/gnunet_namestore_plugin.h +++ b/src/include/gnunet_namestore_plugin.h @@ -1,27 +1,32 @@ /* 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 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. + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + + SPDX-License-Identifier: AGPL3.0-or-later */ /** - * @file include/gnunet_namestore_plugin.h - * @brief plugin API for the namestore database backend * @author Christian Grothoff + * + * @file + * Plugin API for the namestore database backend + * + * @defgroup namestore-plugin Name Store service plugin API + * Plugin API for the namestore database backend + * @{ */ #ifndef GNUNET_NAMESTORE_PLUGIN_H #define GNUNET_NAMESTORE_PLUGIN_H @@ -39,29 +44,23 @@ extern "C" /** - * Function called for matching blocks. - * - * @param cls closure - * @param block lookup result - */ -typedef void (*GNUNET_NAMESTORE_BlockCallback) (void *cls, - const struct GNUNET_NAMESTORE_Block *block); - - -/** - * Function called by for each matching record. + * Function called for each matching record. * * @param cls closure + * @param serial unique serial number of the record, MUST NOT BE ZERO, + * and must be monotonically increasing while iterating * @param zone_key private key of the zone * @param label name that is being mapped (at most 255 characters long) * @param rd_count number of entries in @a rd array * @param rd array of records with data to store */ -typedef void (*GNUNET_NAMESTORE_RecordIterator) (void *cls, - const struct GNUNET_CRYPTO_EcdsaPrivateKey *private_key, - const char *label, - unsigned int rd_count, - const struct GNUNET_NAMESTORE_RecordData *rd); +typedef void +(*GNUNET_NAMESTORE_RecordIterator) (void *cls, + uint64_t serial, + const struct GNUNET_CRYPTO_EcdsaPrivateKey *private_key, + const char *label, + unsigned int rd_count, + const struct GNUNET_GNSRECORD_Data *rd); /** @@ -76,66 +75,62 @@ struct GNUNET_NAMESTORE_PluginFunctions void *cls; /** - * Cache a block in the datastore. Overwrites existing blocks - * for the same zone and label. + * Store a record in the datastore for which we are the authority. + * Removes any existing record in the same zone with the same name. * * @param cls closure (internal context for the plugin) - * @param block block to cache + * @param zone private key of the zone + * @param label name of the record in the zone + * @param rd_count number of entries in @a rd array, 0 to delete all records + * @param rd array of records with data to store * @return #GNUNET_OK on success, else #GNUNET_SYSERR */ - int (*cache_block) (void *cls, - const struct GNUNET_NAMESTORE_Block *block); - + int + (*store_records) (void *cls, + const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone, + const char *label, + unsigned int rd_count, + const struct GNUNET_GNSRECORD_Data *rd); /** - * Get the block for a particular zone and label in the - * datastore. Will return at most one result to the iterator. - * - * @param cls closure (internal context for the plugin) - * @param query hash of public key derived from the zone and the label - * @param iter function to call with the result - * @param iter_cls closure for @a iter - * @return #GNUNET_OK on success, #GNUNET_NO if there were no results, #GNUNET_SYSERR on error - */ - int (*lookup_block) (void *cls, - const struct GNUNET_HashCode *query, - GNUNET_NAMESTORE_BlockCallback iter, void *iter_cls); - - - - /** - * Store a record in the datastore for which we are the authority. - * Removes any existing record in the same zone with the same name. + * Lookup records in the datastore for which we are the authority. * * @param cls closure (internal context for the plugin) * @param zone private key of the zone * @param label name of the record in the zone - * @param rd_count number of entries in @a rd array, 0 to delete all records - * @param rd array of records with data to store - * @return #GNUNET_OK on success, else #GNUNET_SYSERR + * @param iter function to call with the result + * @param iter_cls closure for @a iter + * @return #GNUNET_OK on success, #GNUNET_NO for no results, else #GNUNET_SYSERR */ - int (*store_records) (void *cls, - const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone, - const char *label, - unsigned int rd_count, - const struct GNUNET_NAMESTORE_RecordData *rd); + int + (*lookup_records) (void *cls, + const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone, + const char *label, + GNUNET_NAMESTORE_RecordIterator iter, + void *iter_cls); /** * Iterate over the results for a particular zone in the - * datastore. Will return at most one result to the iterator. + * datastore. Will return at most @a limit results to the iterator. * * @param cls closure (internal context for the plugin) * @param zone private key of the zone, NULL for all zones - * @param offset offset in the list of all matching records + * @param serial serial (to exclude) in the list of matching records; + * 0 means to exclude nothing; results must be returned using + * the minimum possible sequence number first (ordered by serial) + * @param limit maximum number of results to return to @a iter * @param iter function to call with the result * @param iter_cls closure for @a iter - * @return #GNUNET_OK on success, #GNUNET_NO if there were no results, #GNUNET_SYSERR on error + * @return #GNUNET_OK on success, #GNUNET_NO if there were no more results, #GNUNET_SYSERR on error */ - int (*iterate_records) (void *cls, - const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone, - uint64_t offset, - GNUNET_NAMESTORE_RecordIterator iter, void *iter_cls); + int + (*iterate_records) (void *cls, + const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone, + uint64_t serial, + uint64_t limit, + GNUNET_NAMESTORE_RecordIterator iter, + void *iter_cls); /** @@ -149,10 +144,12 @@ struct GNUNET_NAMESTORE_PluginFunctions * @param iter_cls closure for @a iter * @return #GNUNET_OK on success, #GNUNET_NO if there were no results, #GNUNET_SYSERR on error */ - int (*zone_to_name) (void *cls, - const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone, - const struct GNUNET_CRYPTO_EcdsaPublicKey *value_zone, - GNUNET_NAMESTORE_RecordIterator iter, void *iter_cls); + int + (*zone_to_name) (void *cls, + const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone, + const struct GNUNET_CRYPTO_EcdsaPublicKey *value_zone, + GNUNET_NAMESTORE_RecordIterator iter, + void *iter_cls); }; @@ -165,5 +162,6 @@ struct GNUNET_NAMESTORE_PluginFunctions } #endif -/* end of gnunet_namestore_plugin.h */ #endif + +/** @} */ /* end of group */