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/>.
20 * @author Christian Grothoff
23 * Plugin API for the namecache database backend
25 * @defgroup namecache-plugin Name Cache service plugin API
26 * Plugin API for the namecache database backend.
28 * @see [Documentation](https://gnunet.org/namecache-plugin-api)
32 #ifndef GNUNET_NAMECACHE_PLUGIN_H
33 #define GNUNET_NAMECACHE_PLUGIN_H
35 #include "gnunet_util_lib.h"
36 #include "gnunet_namecache_service.h"
37 #include "gnunet_namestore_service.h"
42 #if 0 /* keep Emacsens' auto-indent happy */
49 * Function called for matching blocks.
52 * @param block lookup result
54 typedef void (*GNUNET_NAMECACHE_BlockCallback) (void *cls,
55 const struct GNUNET_GNSRECORD_Block *block);
59 * @brief struct returned by the initialization function of the plugin
61 struct GNUNET_NAMECACHE_PluginFunctions
65 * Closure to pass to all plugin functions.
70 * Cache a block in the datastore. Overwrites existing blocks
71 * for the same zone and label.
73 * @param cls closure (internal context for the plugin)
74 * @param block block to cache
75 * @return #GNUNET_OK on success, else #GNUNET_SYSERR
77 int (*cache_block) (void *cls,
78 const struct GNUNET_GNSRECORD_Block *block);
82 * Get the block for a particular zone and label in the
83 * datastore. Will return at most one result to the iterator.
85 * @param cls closure (internal context for the plugin)
86 * @param query hash of public key derived from the zone and the label
87 * @param iter function to call with the result
88 * @param iter_cls closure for @a iter
89 * @return #GNUNET_OK on success, #GNUNET_NO if there were no results, #GNUNET_SYSERR on error
91 int (*lookup_block) (void *cls,
92 const struct GNUNET_HashCode *query,
93 GNUNET_NAMECACHE_BlockCallback iter, void *iter_cls);
99 #if 0 /* keep Emacsens' auto-indent happy */
108 /** @} */ /* end of group */