1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
/*
This file is part of GNUnet
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
by the Free Software Foundation; either version 3, 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.
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., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
/**
* @author Christian Grothoff
*
* @file
* Plugin API for the namecache database backend
*
* @defgroup namecache-plugin Name Cache service plugin API
* Plugin API for the namecache database backend.
*
* @see [Documentation](https://gnunet.org/namecache-plugin-api)
*
* @{
*/
#ifndef GNUNET_NAMECACHE_PLUGIN_H
#define GNUNET_NAMECACHE_PLUGIN_H
#include "gnunet_util_lib.h"
#include "gnunet_namecache_service.h"
#include "gnunet_namestore_service.h"
#ifdef __cplusplus
extern "C"
{
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif
/**
* Function called for matching blocks.
*
* @param cls closure
* @param block lookup result
*/
typedef void (*GNUNET_NAMECACHE_BlockCallback) (void *cls,
const struct GNUNET_GNSRECORD_Block *block);
/**
* @brief struct returned by the initialization function of the plugin
*/
struct GNUNET_NAMECACHE_PluginFunctions
{
/**
* Closure to pass to all plugin functions.
*/
void *cls;
/**
* Cache a block in the datastore. Overwrites existing blocks
* for the same zone and label.
*
* @param cls closure (internal context for the plugin)
* @param block block to cache
* @return #GNUNET_OK on success, else #GNUNET_SYSERR
*/
int (*cache_block) (void *cls,
const struct GNUNET_GNSRECORD_Block *block);
/**
* 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_NAMECACHE_BlockCallback iter, void *iter_cls);
};
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
#endif
/** @} */ /* end of group */
|
