2 This file is part of GNUnet
3 Copyright (C) 2006, 2009, 2015 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 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 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file datacache/plugin_datacache_template.c
23 * @brief template for an implementation of a database backend for the datacache
24 * @author Christian Grothoff
27 #include "gnunet_util_lib.h"
28 #include "gnunet_datacache_plugin.h"
32 * Context for all functions in this plugin.
37 * Our execution environment.
39 struct GNUNET_DATACACHE_PluginEnvironment *env;
44 * Store an item in the datastore.
46 * @param cls closure (our `struct Plugin`)
47 * @param key key to store @a data under
48 * @param size number of bytes in @a data
49 * @param data data to store
50 * @param type type of the value
51 * @param discard_time when to discard the value in any case
52 * @param path_info_len number of entries in @a path_info
53 * @param path_info a path through the network
54 * @return 0 if duplicate, -1 on error, number of bytes used otherwise
57 template_plugin_put (void *cls,
58 const struct GNUNET_HashCode *key,
61 enum GNUNET_BLOCK_Type type,
62 struct GNUNET_TIME_Absolute discard_time,
63 unsigned int path_info_len,
64 const struct GNUNET_PeerIdentity *path_info)
72 * Iterate over the results for a particular key
75 * @param cls closure (our `struct Plugin`)
77 * @param type entries of which type are relevant?
78 * @param iter maybe NULL (to just count)
79 * @param iter_cls closure for @a iter
80 * @return the number of results found
83 template_plugin_get (void *cls,
84 const struct GNUNET_HashCode *key,
85 enum GNUNET_BLOCK_Type type,
86 GNUNET_DATACACHE_Iterator iter,
95 * Delete the entry with the lowest expiration value
96 * from the datacache right now.
98 * @param cls closure (our `struct Plugin`)
99 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
102 template_plugin_del (void *cls)
105 return GNUNET_SYSERR;
110 * Return a random value from the datastore.
112 * @param cls closure (internal context for the plugin)
113 * @param iter maybe NULL (to just count)
114 * @param iter_cls closure for @a iter
115 * @return the number of results found (zero or one)
118 template_get_random (void *cls,
119 GNUNET_DATACACHE_Iterator iter,
128 * Entry point for the plugin.
130 * @param cls closure (the `struct GNUNET_DATACACHE_PluginEnvironmnet`)
131 * @return the plugin's closure (our `struct Plugin`)
134 libgnunet_plugin_datacache_template_init (void *cls)
136 struct GNUNET_DATACACHE_PluginEnvironment *env = cls;
137 struct GNUNET_DATACACHE_PluginFunctions *api;
138 struct Plugin *plugin;
140 plugin = GNUNET_new (struct Plugin);
142 api = GNUNET_new (struct GNUNET_DATACACHE_PluginFunctions);
144 api->get = &template_plugin_get;
145 api->put = &template_plugin_put;
146 api->del = &template_plugin_del;
147 api->get_random = &template_plugin_get_random;
148 GNUNET_log_from (GNUNET_ERROR_TYPE_INFO,
150 "Template datacache running\n");
156 * Exit point from the plugin.
158 * @param cls closure (our `struct Plugin`)
162 libgnunet_plugin_datacache_template_done (void *cls)
164 struct GNUNET_DATACACHE_PluginFunctions *api = cls;
165 struct Plugin *plugin = api->cls;
167 GNUNET_free (plugin);
173 /* end of plugin_datacache_template.c */