2 This file is part of GNUnet
3 Copyright (C) 2012, 2013, 2018 GNUnet e.V.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @author Christian Grothoff
25 * API that can be used to store naming information on a GNUnet node;
27 * @defgroup namestore Name Store service
28 * Store naming information on a GNUnet node.
30 * Naming information can either be records for which this peer/user is
31 * authoritative, or blocks which are cached, encrypted naming data from other
34 * @see [Documentation](https://gnunet.org/namestore-subsystem)
38 #ifndef GNUNET_NAMESTORE_SERVICE_H
39 #define GNUNET_NAMESTORE_SERVICE_H
41 #include "gnunet_util_lib.h"
42 #include "gnunet_block_lib.h"
43 #include "gnunet_gnsrecord_lib.h"
48 #if 0 /* keep Emacsens' auto-indent happy */
57 struct GNUNET_NAMESTORE_QueueEntry;
60 * Handle to the namestore service.
62 struct GNUNET_NAMESTORE_Handle;
65 * Handle to the namestore zone iterator.
67 struct GNUNET_NAMESTORE_ZoneIterator;
71 * Connect to the namestore service.
73 * @param cfg configuration to use
74 * @return handle to use to access the service
76 struct GNUNET_NAMESTORE_Handle *
77 GNUNET_NAMESTORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
81 * Disconnect from the namestore service (and free associated
82 * resources). Must not be called from within operation callbacks of
85 * @param h handle to the namestore
88 GNUNET_NAMESTORE_disconnect (struct GNUNET_NAMESTORE_Handle *h);
92 * Continuation called to notify client about result of the
96 * @param success #GNUNET_SYSERR on failure (including timeout/queue drop/failure to validate)
97 * #GNUNET_NO if content was already there or not found
98 * #GNUNET_YES (or other positive value) on success
99 * @param emsg NULL on success, otherwise an error message
102 (*GNUNET_NAMESTORE_ContinuationWithStatus) (void *cls,
108 * Store an item in the namestore. If the item is already present,
109 * it is replaced with the new record. Use an empty array to
110 * remove all records under the given name.
112 * @param h handle to the namestore
113 * @param pkey private key of the zone
114 * @param label name that is being mapped
115 * @param rd_count number of records in the 'rd' array
116 * @param rd array of records with data to store
117 * @param cont continuation to call when done
118 * @param cont_cls closure for @a cont
119 * @return handle to abort the request
121 struct GNUNET_NAMESTORE_QueueEntry *
122 GNUNET_NAMESTORE_records_store (struct GNUNET_NAMESTORE_Handle *h,
123 const struct GNUNET_CRYPTO_EcdsaPrivateKey *pkey,
125 unsigned int rd_count,
126 const struct GNUNET_GNSRECORD_Data *rd,
127 GNUNET_NAMESTORE_ContinuationWithStatus cont,
132 * Process a record that was stored in the namestore.
135 * @param zone private key of the zone
136 * @param label label of the records
137 * @param rd_count number of entries in @a rd array, 0 if label was deleted
138 * @param rd array of records with data to store
141 (*GNUNET_NAMESTORE_RecordMonitor) (void *cls,
142 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
144 unsigned int rd_count,
145 const struct GNUNET_GNSRECORD_Data *rd);
149 * Set the desired nick name for a zone
151 * @param h handle to the namestore
152 * @param pkey private key of the zone
153 * @param nick the nick name to set
154 * @param cont continuation to call when done
155 * @param cont_cls closure for @a cont
156 * @return handle to abort the request
158 struct GNUNET_NAMESTORE_QueueEntry *
159 GNUNET_NAMESTORE_set_nick (struct GNUNET_NAMESTORE_Handle *h,
160 const struct GNUNET_CRYPTO_EcdsaPrivateKey *pkey,
162 GNUNET_NAMESTORE_ContinuationWithStatus cont,
167 * Lookup an item in the namestore.
169 * @param h handle to the namestore
170 * @param pkey private key of the zone
171 * @param label name that is being mapped
172 * @param error_cb function to call on error (i.e. disconnect)
173 * the handle is afterwards invalid
174 * @param error_cb_cls closure for @a error_cb
175 * @param rm function to call with the result (with 0 records if we don't have that label);
176 * the handle is afterwards invalid
177 * @param rm_cls closure for @a rm
178 * @return handle to abort the request
180 struct GNUNET_NAMESTORE_QueueEntry *
181 GNUNET_NAMESTORE_records_lookup (struct GNUNET_NAMESTORE_Handle *h,
182 const struct GNUNET_CRYPTO_EcdsaPrivateKey *pkey,
184 GNUNET_SCHEDULER_TaskCallback error_cb,
186 GNUNET_NAMESTORE_RecordMonitor rm,
191 * Look for an existing PKEY delegation record for a given public key.
192 * Returns at most one result to the processor.
194 * @param h handle to the namestore
195 * @param zone private key of the zone to look up in, never NULL
196 * @param value_zone public key of the target zone (value), never NULL
197 * @param error_cb function to call on error (i.e. disconnect)
198 * the handle is afterwards invalid
199 * @param error_cb_cls closure for @a error_cb
200 * @param proc function to call on the matching records, or with
201 * NULL (rd_count == 0) if there are no matching records;
202 * the handle is afterwards invalid
203 * @param proc_cls closure for @a proc
204 * @return a handle that can be used to
207 struct GNUNET_NAMESTORE_QueueEntry *
208 GNUNET_NAMESTORE_zone_to_name (struct GNUNET_NAMESTORE_Handle *h,
209 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
210 const struct GNUNET_CRYPTO_EcdsaPublicKey *value_zone,
211 GNUNET_SCHEDULER_TaskCallback error_cb,
213 GNUNET_NAMESTORE_RecordMonitor proc,
218 * Cancel a namestore operation. The final callback from the
219 * operation must not have been done yet. Must be called on any
220 * namestore operation that has not yet completed prior to calling
221 * #GNUNET_NAMESTORE_disconnect.
223 * @param qe operation to cancel
226 GNUNET_NAMESTORE_cancel (struct GNUNET_NAMESTORE_QueueEntry *qe);
230 * Starts a new zone iteration (used to periodically PUT all of our
231 * records into our DHT). This MUST lock the `struct GNUNET_NAMESTORE_Handle`
232 * for any other calls than #GNUNET_NAMESTORE_zone_iterator_next() and
233 * #GNUNET_NAMESTORE_zone_iteration_stop. @a proc will be called once
234 * immediately, and then again after
235 * #GNUNET_NAMESTORE_zone_iterator_next() is invoked.
237 * On error (disconnect), @a error_cb will be invoked.
238 * On normal completion, @a finish_cb proc will be
241 * @param h handle to the namestore
242 * @param zone zone to access, NULL for all zones
243 * @param error_cb function to call on error (i.e. disconnect),
244 * the handle is afterwards invalid
245 * @param error_cb_cls closure for @a error_cb
246 * @param proc function to call on each name from the zone; it
247 * will be called repeatedly with a value (if available)
248 * @param proc_cls closure for @a proc
249 * @param finish_cb function to call on completion
250 * the handle is afterwards invalid
251 * @param finish_cb_cls closure for @a finish_cb
252 * @return an iterator handle to use for iteration
254 struct GNUNET_NAMESTORE_ZoneIterator *
255 GNUNET_NAMESTORE_zone_iteration_start (struct GNUNET_NAMESTORE_Handle *h,
256 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
257 GNUNET_SCHEDULER_TaskCallback error_cb,
259 GNUNET_NAMESTORE_RecordMonitor proc,
261 GNUNET_SCHEDULER_TaskCallback finish_cb,
262 void *finish_cb_cls);
266 * Calls the record processor specified in #GNUNET_NAMESTORE_zone_iteration_start
267 * for the next record.
269 * @param it the iterator
272 GNUNET_NAMESTORE_zone_iterator_next (struct GNUNET_NAMESTORE_ZoneIterator *it);
276 * Stops iteration and releases the namestore handle for further calls. Must
277 * be called on any iteration that has not yet completed prior to calling
278 * #GNUNET_NAMESTORE_disconnect.
280 * @param it the iterator
283 GNUNET_NAMESTORE_zone_iteration_stop (struct GNUNET_NAMESTORE_ZoneIterator *it);
287 * Handle for a monitoring activity.
289 struct GNUNET_NAMESTORE_ZoneMonitor;
293 * Begin monitoring a zone for changes. Will first call the @a
294 * monitor function on all existing records in the selected zone(s) if
295 * @a iterate_first is #GNUNET_YES. In any case, we will then call @a
296 * sync_cb, and then afterwards call the @a monitor whenever a record
297 * changes. If the namestore disconnects, the @a error_cb function is
298 * called with a disconnect event. Once the connection is
299 * re-established, the process begins from the start (depending on @a
300 * iterate_first, we will again first do all existing records, then @a
301 * sync, then updates).
303 * @param cfg configuration to use to connect to namestore
304 * @param zone zone to monitor, NULL for all zones
305 * @param iterate_first #GNUNET_YES to first iterate over all existing records,
306 * #GNUNET_NO to only return changes that happen from now on
307 * @param error_cb function to call on error (i.e. disconnect); note that
308 * unlike the other error callbacks in this API, a call to this
309 * function does NOT destroy the monitor handle, it merely signals
310 * that monitoring is down. You need to still explicitly call
311 * #GNUNET_NAMESTORE_zone_monitor_stop().
312 * @param error_cb_cls closure for @a error_cb
313 * @param monitor function to call on zone changes
314 * @param monitor_cls closure for @a monitor
315 * @param sync_cb function called when we're in sync with the namestore
316 * @param sync_cb_cls closure for @a sync_cb
317 * @return handle to stop monitoring
319 struct GNUNET_NAMESTORE_ZoneMonitor *
320 GNUNET_NAMESTORE_zone_monitor_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
321 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
323 GNUNET_SCHEDULER_TaskCallback error_cb,
325 GNUNET_NAMESTORE_RecordMonitor monitor,
327 GNUNET_SCHEDULER_TaskCallback sync_cb,
332 * Stop monitoring a zone for changes.
334 * @param zm handle to the monitor activity to stop
337 GNUNET_NAMESTORE_zone_monitor_stop (struct GNUNET_NAMESTORE_ZoneMonitor *zm);
340 #if 0 /* keep Emacsens' auto-indent happy */
349 /** @} */ /* end of group */