2 This file is part of GNUnet
3 (C) 2012, 2013 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 include/gnunet_peerstore_plugin.h
23 * @brief plugin API for the peerstore database backend
24 * @author Omar Tarabai
26 #ifndef GNUNET_PEERSTORE_PLUGIN_H
27 #define GNUNET_PEERSTORE_PLUGIN_H
29 #include "gnunet_util_lib.h"
30 #include "gnunet_peerstore_service.h"
35 #if 0 /* keep Emacsens' auto-indent happy */
42 * @brief struct returned by the initialization function of the plugin
44 struct GNUNET_PEERSTORE_PluginFunctions
48 * Closure to pass to all plugin functions.
53 * Store a record in the peerstore.
54 * Key is the combination of sub system and peer identity.
55 * One key can store multiple values.
57 * @param cls closure (internal context for the plugin)
58 * @param sub_system name of the GNUnet sub system responsible
59 * @param peer peer identity
60 * @param value value to be stored
61 * @param size size of value to be stored
62 * @return #GNUNET_OK on success, else #GNUNET_SYSERR
65 (*store_record) (void *cls,
66 const char *sub_system,
67 const struct GNUNET_PeerIdentity *peer,
71 struct GNUNET_TIME_Absolute expiry);
74 * Iterate over the records given an optional peer id
77 * @param cls closure (internal context for the plugin)
78 * @param sub_system name of sub system
79 * @param peer Peer identity (can be NULL)
80 * @param key entry key string (can be NULL)
81 * @param iter function to call with the result
82 * @param iter_cls closure for @a iter
83 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
86 (*iterate_records) (void *cls,
87 const char *sub_system,
88 const struct GNUNET_PeerIdentity *peer,
90 GNUNET_PEERSTORE_Processor iter, void *iter_cls);
93 * Delete expired records (expiry < now)
95 * @param cls closure (internal context for the plugin)
96 * @param now time to use as reference
97 * @return number of records deleted
100 (*expire_records) (void *cls,
101 struct GNUNET_TIME_Absolute now);
106 #if 0 /* keep Emacsens' auto-indent happy */
113 /* end of gnunet_peerstore_plugin.h */