2 This file is part of GNUnet
3 Copyright (C) GNUnet e.V. 2004--2019
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/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
22 * @author Omar Tarabai
25 * API to the peerstore service
27 * @defgroup peerstore Peer Store service
29 * @see [Documentation](https://gnunet.org/gnunets-peerstore-subsystem)
33 #ifndef GNUNET_PEERSTORE_SERVICE_H
34 #define GNUNET_PEERSTORE_SERVICE_H
36 #include "gnunet_util_lib.h"
40 #if 0 /* keep Emacsens' auto-indent happy */
47 * Key used for storing addresses in URL format in the peerstore
49 #define GNUNET_PEERSTORE_TRANSPORT_URLADDRESS_KEY "transport-communicator-url"
52 * Key used for storing HELLOs in the peerstore
54 #define GNUNET_PEERSTORE_TRANSPORT_HELLO_KEY "transport-peer-hello"
57 * Key used to store sender's monotonic time from backchannel
60 #define GNUNET_PEERSTORE_TRANSPORT_BACKCHANNEL_MONOTIME \
61 "transport-backchannel-monotonic-time"
64 * Key used to store sender's monotonic time from DV learn
67 #define GNUNET_PEERSTORE_TRANSPORT_DVLEARN_MONOTIME \
68 "transport-dv-learn-monotonic-time"
72 * Options for storing values in PEERSTORE
74 enum GNUNET_PEERSTORE_StoreOption
78 * Possibly store multiple values under given key.
80 GNUNET_PEERSTORE_STOREOPTION_MULTIPLE = 0,
83 * Delete any previous values for the given key before
84 * storing the given value.
86 GNUNET_PEERSTORE_STOREOPTION_REPLACE = 1
91 * Handle to the peerstore service.
93 struct GNUNET_PEERSTORE_Handle;
96 * Context for a store request
98 struct GNUNET_PEERSTORE_StoreContext;
101 * Single PEERSTORE record
103 struct GNUNET_PEERSTORE_Record
107 * Responsible sub system string
114 struct GNUNET_PeerIdentity peer;
127 * Size of @e value BLOB
132 * Expiry time of entry
134 struct GNUNET_TIME_Absolute expiry;
137 * Client from which this record originated.
138 * NOTE: This is internal to the service.
140 struct GNUNET_SERVICE_Client *client;
145 * Continuation called with a status result.
148 * @param success #GNUNET_OK or #GNUNET_SYSERR
150 typedef void (*GNUNET_PEERSTORE_Continuation) (void *cls, int success);
154 * Function called by PEERSTORE for each matching record.
157 * @param record peerstore record information
158 * @param emsg error message, or NULL if no errors
160 typedef void (*GNUNET_PEERSTORE_Processor) (
162 const struct GNUNET_PEERSTORE_Record *record,
167 * Connect to the PEERSTORE service.
169 * @return NULL on error
171 struct GNUNET_PEERSTORE_Handle *
172 GNUNET_PEERSTORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
176 * Disconnect from the PEERSTORE service. Any pending ITERATE and WATCH requests
178 * Any pending STORE requests will depend on @e snyc_first flag.
180 * @param h handle to disconnect
181 * @param sync_first send any pending STORE requests before disconnecting
184 GNUNET_PEERSTORE_disconnect (struct GNUNET_PEERSTORE_Handle *h, int sync_first);
188 * Store a new entry in the PEERSTORE.
189 * Note that stored entries can be lost in some cases
190 * such as power failure.
192 * @param h Handle to the PEERSTORE service
193 * @param sub_system name of the sub system
194 * @param peer Peer Identity
195 * @param key entry key
196 * @param value entry value BLOB
197 * @param size size of @e value
198 * @param expiry absolute time after which the entry is (possibly) deleted
199 * @param options options specific to the storage operation
200 * @param cont Continuation function after the store request is sent
201 * @param cont_cls Closure for @a cont
203 struct GNUNET_PEERSTORE_StoreContext *
204 GNUNET_PEERSTORE_store (struct GNUNET_PEERSTORE_Handle *h,
205 const char *sub_system,
206 const struct GNUNET_PeerIdentity *peer,
210 struct GNUNET_TIME_Absolute expiry,
211 enum GNUNET_PEERSTORE_StoreOption options,
212 GNUNET_PEERSTORE_Continuation cont,
217 * Cancel a store request
219 * @param sc Store request context
222 GNUNET_PEERSTORE_store_cancel (struct GNUNET_PEERSTORE_StoreContext *sc);
226 * Iterate over records matching supplied key information
228 * @param h handle to the PEERSTORE service
229 * @param sub_system name of sub system
230 * @param peer Peer identity (can be NULL)
231 * @param key entry key string (can be NULL)
232 * @param callback function called with each matching record, all NULL's on end
233 * @param callback_cls closure for @a callback
235 struct GNUNET_PEERSTORE_IterateContext *
236 GNUNET_PEERSTORE_iterate (struct GNUNET_PEERSTORE_Handle *h,
237 const char *sub_system,
238 const struct GNUNET_PeerIdentity *peer,
240 GNUNET_PEERSTORE_Processor callback,
245 * Cancel an iterate request
246 * Please do not call after the iterate request is done
248 * @param ic Iterate request context as returned by GNUNET_PEERSTORE_iterate()
251 GNUNET_PEERSTORE_iterate_cancel (struct GNUNET_PEERSTORE_IterateContext *ic);
255 * Request watching a given key
256 * User will be notified with any new values added to key.
258 * @param h handle to the PEERSTORE service
259 * @param sub_system name of sub system
260 * @param peer Peer identity
261 * @param key entry key string
262 * @param callback function called with each new value
263 * @param callback_cls closure for @a callback
264 * @return Handle to watch request
266 struct GNUNET_PEERSTORE_WatchContext *
267 GNUNET_PEERSTORE_watch (struct GNUNET_PEERSTORE_Handle *h,
268 const char *sub_system,
269 const struct GNUNET_PeerIdentity *peer,
271 GNUNET_PEERSTORE_Processor callback,
276 * Cancel a watch request
278 * @param wc handle to the watch request
281 GNUNET_PEERSTORE_watch_cancel (struct GNUNET_PEERSTORE_WatchContext *wc);
284 #if 0 /* keep Emacsens' auto-indent happy */
293 /** @} */ /* end of group */