2 This file is part of GNUnet
3 Copyright (C) 2012, 2013 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,
133 * Process a record that was stored in the namestore.
136 * @param zone private key of the zone
137 * @param label label of the records
138 * @param rd_count number of entries in @a rd array, 0 if label was deleted
139 * @param rd array of records with data to store
142 (*GNUNET_NAMESTORE_RecordMonitor) (void *cls,
143 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
145 unsigned int rd_count,
146 const struct GNUNET_GNSRECORD_Data *rd);
150 * Set the desired nick name for a zone
152 * @param h handle to the namestore
153 * @param pkey private key of the zone
154 * @param nick the nick name to set
155 * @param cont continuation to call when done
156 * @param cont_cls closure for 'cont'
157 * @return handle to abort the request
159 struct GNUNET_NAMESTORE_QueueEntry *
160 GNUNET_NAMESTORE_set_nick (struct GNUNET_NAMESTORE_Handle *h,
161 const struct GNUNET_CRYPTO_EcdsaPrivateKey *pkey,
163 GNUNET_NAMESTORE_ContinuationWithStatus cont,
168 * Lookup an item in the namestore.
170 * @param h handle to the namestore
171 * @param pkey private key of the zone
172 * @param label name that is being mapped
173 * @param error_cb function to call on error (i.e. disconnect)
174 * the handle is afterwards invalid
175 * @param error_cb_cls closure for @a error_cb
176 * @param rm function to call with the result (with 0 records if we don't have that label);
177 * the handle is afterwards invalid
178 * @param rm_cls closure for @a rm
179 * @return handle to abort the request
181 struct GNUNET_NAMESTORE_QueueEntry *
182 GNUNET_NAMESTORE_records_lookup (struct GNUNET_NAMESTORE_Handle *h,
183 const struct GNUNET_CRYPTO_EcdsaPrivateKey *pkey,
185 GNUNET_SCHEDULER_TaskCallback error_cb,
187 GNUNET_NAMESTORE_RecordMonitor rm,
192 * Look for an existing PKEY delegation record for a given public key.
193 * Returns at most one result to the processor.
195 * @param h handle to the namestore
196 * @param zone public key of the zone to look up in, never NULL
197 * @param value_zone public key of the target zone (value), never NULL
198 * @param error_cb function to call on error (i.e. disconnect)
199 * the handle is afterwards invalid
200 * @param error_cb_cls closure for @a error_cb
201 * @param proc function to call on the matching records, or with
202 * NULL (rd_count == 0) if there are no matching records;
203 * the handle is afterwards invalid
204 * @param proc_cls closure for @a proc
205 * @return a handle that can be used to
208 struct GNUNET_NAMESTORE_QueueEntry *
209 GNUNET_NAMESTORE_zone_to_name (struct GNUNET_NAMESTORE_Handle *h,
210 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
211 const struct GNUNET_CRYPTO_EcdsaPublicKey *value_zone,
212 GNUNET_SCHEDULER_TaskCallback error_cb,
214 GNUNET_NAMESTORE_RecordMonitor proc,
219 * Cancel a namestore operation. The final callback from the
220 * operation must not have been done yet. Must be called on any
221 * namestore operation that has not yet completed prior to calling
222 * #GNUNET_NAMESTORE_disconnect.
224 * @param qe operation to cancel
227 GNUNET_NAMESTORE_cancel (struct GNUNET_NAMESTORE_QueueEntry *qe);
231 * Starts a new zone iteration (used to periodically PUT all of our
232 * records into our DHT). This MUST lock the `struct GNUNET_NAMESTORE_Handle`
233 * for any other calls than #GNUNET_NAMESTORE_zone_iterator_next() and
234 * #GNUNET_NAMESTORE_zone_iteration_stop. @a proc will be called once
235 * immediately, and then again after
236 * #GNUNET_NAMESTORE_zone_iterator_next() is invoked.
238 * On error (disconnect), @a error_cb will be invoked.
239 * On normal completion, @a finish_cb proc will be
242 * @param h handle to the namestore
243 * @param zone zone to access, NULL for all zones
244 * @param error_cb function to call on error (i.e. disconnect),
245 * the handle is afterwards invalid
246 * @param error_cb_cls closure for @a error_cb
247 * @param proc function to call on each name from the zone; it
248 * will be called repeatedly with a value (if available)
249 * @param proc_cls closure for @a proc
250 * @param finish_cb function to call on completion
251 * the handle is afterwards invalid
252 * @param finish_cb_cls closure for @a finish_cb
253 * @return an iterator handle to use for iteration
255 struct GNUNET_NAMESTORE_ZoneIterator *
256 GNUNET_NAMESTORE_zone_iteration_start (struct GNUNET_NAMESTORE_Handle *h,
257 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
258 GNUNET_SCHEDULER_TaskCallback error_cb,
260 GNUNET_NAMESTORE_RecordMonitor proc,
262 GNUNET_SCHEDULER_TaskCallback finish_cb,
263 void *finish_cb_cls);
267 * Calls the record processor specified in #GNUNET_NAMESTORE_zone_iteration_start
268 * for the next record.
270 * @param it the iterator
273 GNUNET_NAMESTORE_zone_iterator_next (struct GNUNET_NAMESTORE_ZoneIterator *it);
277 * Stops iteration and releases the namestore handle for further calls. Must
278 * be called on any iteration that has not yet completed prior to calling
279 * #GNUNET_NAMESTORE_disconnect.
281 * @param it the iterator
284 GNUNET_NAMESTORE_zone_iteration_stop (struct GNUNET_NAMESTORE_ZoneIterator *it);
288 * Handle for a monitoring activity.
290 struct GNUNET_NAMESTORE_ZoneMonitor;
294 * Begin monitoring a zone for changes. Will first call the @a
295 * monitor function on all existing records in the selected zone(s) if
296 * @a iterate_first is #GNUNET_YES. In any case, we will then call @a
297 * sync_cb, and then afterwards call the @a monitor whenever a record
298 * changes. If the namestore disconnects, the @a error_cb function is
299 * called with a disconnect event. Once the connection is
300 * re-established, the process begins from the start (depending on @a
301 * iterate_first, we will again first do all existing records, then @a
302 * sync, then updates).
304 * @param cfg configuration to use to connect to namestore
305 * @param zone zone to monitor, NULL for all zones
306 * @param iterate_first #GNUNET_YES to first iterate over all existing records,
307 * #GNUNET_NO to only return changes that happen from now on
308 * @param error_cb function to call on error (i.e. disconnect); note that
309 * unlike the other error callbacks in this API, a call to this
310 * function does NOT destroy the monitor handle, it merely signals
311 * that monitoring is down. You need to still explicitly call
312 * #GNUNET_NAMESTORE_zone_monitor_stop().
313 * @param error_cb_cls closure for @a error_cb
314 * @param monitor function to call on zone changes
315 * @param monitor_cls closure for @a monitor
316 * @param sync_cb function called when we're in sync with the namestore
317 * @param sync_cb_cls closure for @a sync_cb
318 * @return handle to stop monitoring
320 struct GNUNET_NAMESTORE_ZoneMonitor *
321 GNUNET_NAMESTORE_zone_monitor_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
322 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
324 GNUNET_SCHEDULER_TaskCallback error_cb,
326 GNUNET_NAMESTORE_RecordMonitor monitor,
328 GNUNET_SCHEDULER_TaskCallback sync_cb,
333 * Stop monitoring a zone for changes.
335 * @param zm handle to the monitor activity to stop
338 GNUNET_NAMESTORE_zone_monitor_stop (struct GNUNET_NAMESTORE_ZoneMonitor *zm);
341 #if 0 /* keep Emacsens' auto-indent happy */
350 /** @} */ /* end of group */