2 This file is part of GNUnet
3 Copyright (C) 2012, 2013 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
22 * @author Christian Grothoff
25 * Plugin API for the namecache database backend
27 * @defgroup namecache-plugin Name Cache service plugin API
28 * Plugin API for the namecache database backend.
30 * @see [Documentation](https://gnunet.org/namecache-plugin-api)
34 #ifndef GNUNET_NAMECACHE_PLUGIN_H
35 #define GNUNET_NAMECACHE_PLUGIN_H
37 #include "gnunet_util_lib.h"
38 #include "gnunet_namecache_service.h"
39 #include "gnunet_namestore_service.h"
44 #if 0 /* keep Emacsens' auto-indent happy */
51 * Function called for matching blocks.
54 * @param block lookup result
56 typedef void (*GNUNET_NAMECACHE_BlockCallback) (void *cls,
57 const struct GNUNET_GNSRECORD_Block *block);
61 * @brief struct returned by the initialization function of the plugin
63 struct GNUNET_NAMECACHE_PluginFunctions
67 * Closure to pass to all plugin functions.
72 * Cache a block in the datastore. Overwrites existing blocks
73 * for the same zone and label.
75 * @param cls closure (internal context for the plugin)
76 * @param block block to cache
77 * @return #GNUNET_OK on success, else #GNUNET_SYSERR
79 int (*cache_block) (void *cls,
80 const struct GNUNET_GNSRECORD_Block *block);
84 * Get the block for a particular zone and label in the
85 * datastore. Will return at most one result to the iterator.
87 * @param cls closure (internal context for the plugin)
88 * @param query hash of public key derived from the zone and the label
89 * @param iter function to call with the result
90 * @param iter_cls closure for @a iter
91 * @return #GNUNET_OK on success, #GNUNET_NO if there were no results, #GNUNET_SYSERR on error
93 int (*lookup_block) (void *cls,
94 const struct GNUNET_HashCode *query,
95 GNUNET_NAMECACHE_BlockCallback iter, void *iter_cls);
101 #if 0 /* keep Emacsens' auto-indent happy */
110 /** @} */ /* end of group */