2 This file is part of GNUnet
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_service.h
23 * @brief API to the peerstore service
24 * @author Omar Tarabai
26 #ifndef GNUNET_PEERSTORE_SERVICE_H
27 #define GNUNET_PEERSTORE_SERVICE_H
30 #include "gnunet_util_lib.h"
35 #if 0 /* keep Emacsens' auto-indent happy */
41 * Options for storing values in PEERSTORE
43 enum GNUNET_PEERSTORE_StoreOption
47 * Possibly store multiple values under given key.
49 GNUNET_PEERSTORE_STOREOPTION_MULTIPLE = 0,
52 * Delete any previous values for the given key before
53 * storing the given value.
55 GNUNET_PEERSTORE_STOREOPTION_REPLACE = 1,
60 * Handle to the peerstore service.
62 struct GNUNET_PEERSTORE_Handle;
65 * Context for a store request
67 struct GNUNET_PEERSTORE_StoreContext;
70 * Single PEERSTORE record
72 struct GNUNET_PEERSTORE_Record
76 * Responsible sub system string
83 struct GNUNET_PeerIdentity *peer;
96 * Size of 'value' BLOB
101 * Expiry time of entry
103 struct GNUNET_TIME_Absolute *expiry;
106 * Client from which this record originated
108 struct GNUNET_SERVER_Client *client;
112 * Continuation called with a status result.
115 * @param success #GNUNET_OK or #GNUNET_SYSERR
117 typedef void (*GNUNET_PEERSTORE_Continuation)(void *cls, int success);
120 * Function called by PEERSTORE for each matching record.
123 * @param record peerstore record information
124 * @param emsg error message, or NULL if no errors
125 * @return #GNUNET_YES to continue iterating, #GNUNET_NO to stop
127 typedef int (*GNUNET_PEERSTORE_Processor) (void *cls,
128 struct GNUNET_PEERSTORE_Record *record,
132 * Connect to the PEERSTORE service.
134 * @return NULL on error
136 struct GNUNET_PEERSTORE_Handle *
137 GNUNET_PEERSTORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
140 * Disconnect from the PEERSTORE service. Any pending ITERATE and WATCH requests
142 * Any pending STORE requests will depend on @e snyc_first flag.
144 * @param h handle to disconnect
145 * @param sync_first send any pending STORE requests before disconnecting
148 GNUNET_PEERSTORE_disconnect (struct GNUNET_PEERSTORE_Handle *h, int sync_first);
151 * Store a new entry in the PEERSTORE.
152 * Note that stored entries can be lost in some cases
153 * such as power failure.
155 * @param h Handle to the PEERSTORE service
156 * @param sub_system name of the sub system
157 * @param peer Peer Identity
158 * @param key entry key
159 * @param value entry value BLOB
160 * @param size size of @e value
161 * @param expiry absolute time after which the entry is (possibly) deleted
162 * @param options options specific to the storage operation
163 * @param cont Continuation function after the store request is sent
164 * @param cont_cls Closure for 'cont'
166 struct GNUNET_PEERSTORE_StoreContext *
167 GNUNET_PEERSTORE_store (struct GNUNET_PEERSTORE_Handle *h,
168 const char *sub_system,
169 const struct GNUNET_PeerIdentity *peer,
173 struct GNUNET_TIME_Absolute expiry,
174 enum GNUNET_PEERSTORE_StoreOption options,
175 GNUNET_PEERSTORE_Continuation cont,
179 * Cancel a store request
181 * @param sc Store request context
184 GNUNET_PEERSTORE_store_cancel (struct GNUNET_PEERSTORE_StoreContext *sc);
187 * Iterate over records matching supplied key information
189 * @param h handle to the PEERSTORE service
190 * @param sub_system name of sub system
191 * @param peer Peer identity (can be NULL)
192 * @param key entry key string (can be NULL)
193 * @param timeout time after which the iterate request is canceled
194 * @param callback function called with each matching record, all NULL's on end
195 * @param callback_cls closure for @a callback
197 struct GNUNET_PEERSTORE_IterateContext *
198 GNUNET_PEERSTORE_iterate (struct GNUNET_PEERSTORE_Handle *h,
199 const char *sub_system,
200 const struct GNUNET_PeerIdentity *peer,
202 struct GNUNET_TIME_Relative timeout,
203 GNUNET_PEERSTORE_Processor callback, void *callback_cls);
206 * Cancel an iterate request
207 * Please do not call after the iterate request is done
209 * @param ic Iterate request context as returned by GNUNET_PEERSTORE_iterate()
212 GNUNET_PEERSTORE_iterate_cancel (struct GNUNET_PEERSTORE_IterateContext *ic);
215 * Request watching a given key
216 * User will be notified with any new values added to key
218 * @param h handle to the PEERSTORE service
219 * @param sub_system name of sub system
220 * @param peer Peer identity
221 * @param key entry key string
222 * @param callback function called with each new value
223 * @param callback_cls closure for @a callback
224 * @return Handle to watch request
226 struct GNUNET_PEERSTORE_WatchContext *
227 GNUNET_PEERSTORE_watch (struct GNUNET_PEERSTORE_Handle *h,
228 const char *sub_system,
229 const struct GNUNET_PeerIdentity *peer,
231 GNUNET_PEERSTORE_Processor callback, void *callback_cls);
234 * Cancel a watch request
236 * @param wc handle to the watch request
239 GNUNET_PEERSTORE_watch_cancel(struct GNUNET_PEERSTORE_WatchContext *wc);
241 #if 0 /* keep Emacsens' auto-indent happy */