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_namestore_service.h
23 * @brief API that can be used to store naming information on a GNUnet node;
24 * Naming information can either be records for which this peer/user
25 * is authoritative, or blocks which are cached, encrypted naming
26 * data from other peers.
27 * @author Christian Grothoff
29 #ifndef GNUNET_NAMESTORE_SERVICE_H
30 #define GNUNET_NAMESTORE_SERVICE_H
32 #include "gnunet_util_lib.h"
33 #include "gnunet_block_lib.h"
34 #include "gnunet_gnsrecord_lib.h"
39 #if 0 /* keep Emacsens' auto-indent happy */
48 struct GNUNET_NAMESTORE_QueueEntry;
51 * Handle to the namestore service.
53 struct GNUNET_NAMESTORE_Handle;
56 * Handle to the namestore zone iterator.
58 struct GNUNET_NAMESTORE_ZoneIterator;
62 * Connect to the namestore service.
64 * @param cfg configuration to use
65 * @return handle to use to access the service
67 struct GNUNET_NAMESTORE_Handle *
68 GNUNET_NAMESTORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
72 * Disconnect from the namestore service (and free associated
73 * resources). Must not be called from within operation callbacks of
76 * @param h handle to the namestore
79 GNUNET_NAMESTORE_disconnect (struct GNUNET_NAMESTORE_Handle *h);
83 * Continuation called to notify client about result of the
87 * @param success #GNUNET_SYSERR on failure (including timeout/queue drop/failure to validate)
88 * #GNUNET_NO if content was already there or not found
89 * #GNUNET_YES (or other positive value) on success
90 * @param emsg NULL on success, otherwise an error message
93 (*GNUNET_NAMESTORE_ContinuationWithStatus) (void *cls,
99 * Store an item in the namestore. If the item is already present,
100 * it is replaced with the new record. Use an empty array to
101 * remove all records under the given name.
103 * @param h handle to the namestore
104 * @param pkey private key of the zone
105 * @param label name that is being mapped
106 * @param rd_count number of records in the 'rd' array
107 * @param rd array of records with data to store
108 * @param cont continuation to call when done
109 * @param cont_cls closure for @a cont
110 * @return handle to abort the request
112 struct GNUNET_NAMESTORE_QueueEntry *
113 GNUNET_NAMESTORE_records_store (struct GNUNET_NAMESTORE_Handle *h,
114 const struct GNUNET_CRYPTO_EcdsaPrivateKey *pkey,
116 unsigned int rd_count,
117 const struct GNUNET_GNSRECORD_Data *rd,
118 GNUNET_NAMESTORE_ContinuationWithStatus cont,
124 * Process a record that was stored in the namestore.
127 * @param zone private key of the zone; NULL on disconnect
128 * @param label label of the records; NULL on disconnect
129 * @param rd_count number of entries in @a rd array, 0 if label was deleted
130 * @param rd array of records with data to store
133 (*GNUNET_NAMESTORE_RecordMonitor) (void *cls,
134 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
136 unsigned int rd_count,
137 const struct GNUNET_GNSRECORD_Data *rd);
141 * Set the desired nick name for a zone
143 * @param h handle to the namestore
144 * @param pkey private key of the zone
145 * @param nick the nick name to set
146 * @param cont continuation to call when done
147 * @param cont_cls closure for 'cont'
148 * @return handle to abort the request
150 struct GNUNET_NAMESTORE_QueueEntry *
151 GNUNET_NAMESTORE_set_nick (struct GNUNET_NAMESTORE_Handle *h,
152 const struct GNUNET_CRYPTO_EcdsaPrivateKey *pkey,
154 GNUNET_NAMESTORE_ContinuationWithStatus cont,
158 * Lookup an item in the namestore.
160 * @param h handle to the namestore
161 * @param pkey private key of the zone
162 * @param label name that is being mapped
163 * @param rm function to call with the result (with 0 records if we don't have that label)
164 * @param rm_cls closure for @a rm
165 * @return handle to abort the request
167 struct GNUNET_NAMESTORE_QueueEntry *
168 GNUNET_NAMESTORE_records_lookup (struct GNUNET_NAMESTORE_Handle *h,
169 const struct GNUNET_CRYPTO_EcdsaPrivateKey *pkey,
171 GNUNET_NAMESTORE_RecordMonitor rm,
176 * Look for an existing PKEY delegation record for a given public key.
177 * Returns at most one result to the processor.
179 * @param h handle to the namestore
180 * @param zone public key of the zone to look up in, never NULL
181 * @param value_zone public key of the target zone (value), never NULL
182 * @param proc function to call on the matching records, or with
183 * NULL (rd_count == 0) if there are no matching records
184 * @param proc_cls closure for @a proc
185 * @return a handle that can be used to
188 struct GNUNET_NAMESTORE_QueueEntry *
189 GNUNET_NAMESTORE_zone_to_name (struct GNUNET_NAMESTORE_Handle *h,
190 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
191 const struct GNUNET_CRYPTO_EcdsaPublicKey *value_zone,
192 GNUNET_NAMESTORE_RecordMonitor proc, void *proc_cls);
196 * Cancel a namestore operation. The final callback from the
197 * operation must not have been done yet. Must be called on any
198 * namestore operation that has not yet completed prior to calling
199 * #GNUNET_NAMESTORE_disconnect.
201 * @param qe operation to cancel
204 GNUNET_NAMESTORE_cancel (struct GNUNET_NAMESTORE_QueueEntry *qe);
208 * Starts a new zone iteration (used to periodically PUT all of our
209 * records into our DHT). This MUST lock the struct GNUNET_NAMESTORE_Handle
210 * for any other calls than #GNUNET_NAMESTORE_zone_iterator_next and
211 * #GNUNET_NAMESTORE_zone_iteration_stop. @a proc will be called once
212 * immediately, and then again after
213 * #GNUNET_NAMESTORE_zone_iterator_next is invoked.
215 * @param h handle to the namestore
216 * @param zone zone to access, NULL for all zones
217 * @param proc function to call on each name from the zone; it
218 * will be called repeatedly with a value (if available)
219 * and always once at the end with a label of NULL.
220 * @param proc_cls closure for @a proc
221 * @return an iterator handle to use for iteration
223 struct GNUNET_NAMESTORE_ZoneIterator *
224 GNUNET_NAMESTORE_zone_iteration_start (struct GNUNET_NAMESTORE_Handle *h,
225 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
226 GNUNET_NAMESTORE_RecordMonitor proc,
231 * Calls the record processor specified in #GNUNET_NAMESTORE_zone_iteration_start
232 * for the next record.
234 * @param it the iterator
237 GNUNET_NAMESTORE_zone_iterator_next (struct GNUNET_NAMESTORE_ZoneIterator *it);
241 * Stops iteration and releases the namestore handle for further calls. Must
242 * be called on any iteration that has not yet completed prior to calling
243 * #GNUNET_NAMESTORE_disconnect.
245 * @param it the iterator
248 GNUNET_NAMESTORE_zone_iteration_stop (struct GNUNET_NAMESTORE_ZoneIterator *it);
252 * Handle for a monitoring activity.
254 struct GNUNET_NAMESTORE_ZoneMonitor;
258 * Function called once the monitor has caught up with the current
259 * state of the database. Will be called AGAIN after each disconnect
260 * (record monitor called with 'NULL' for zone_key) once we're again
266 (*GNUNET_NAMESTORE_RecordsSynchronizedCallback)(void *cls);
270 * Begin monitoring a zone for changes. Will first call the @a
271 * monitor function on all existing records in the selected zone(s) if
272 * @a iterate_first is #GNUNET_YES. In any case, we will then call @a
273 * sync_cb, and then afterwards call the @a monitor whenever a record
274 * changes. If the namestore disconnects, the @a monitor function is
275 * called with a disconnect event; if the connection is
276 * re-established, the process begins from the start (depending on @a
277 * iterate_first, we first do all existing records, then @a sync, then
280 * @param cfg configuration to use to connect to namestore
281 * @param zone zone to monitor, NULL for all zones
282 * @param iterate_first #GNUNET_YES to first iterate over all existing records,
283 * #GNUNET_NO to only return changes that happen from now on
284 * @param monitor function to call on zone changes
285 * @param sync_cb function called when we're in sync with the namestore
286 * @param cls closure for @a monitor and @a sync_cb
287 * @return handle to stop monitoring
289 struct GNUNET_NAMESTORE_ZoneMonitor *
290 GNUNET_NAMESTORE_zone_monitor_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
291 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
293 GNUNET_NAMESTORE_RecordMonitor monitor,
294 GNUNET_NAMESTORE_RecordsSynchronizedCallback sync_cb,
299 * Stop monitoring a zone for changes.
301 * @param zm handle to the monitor activity to stop
304 GNUNET_NAMESTORE_zone_monitor_stop (struct GNUNET_NAMESTORE_ZoneMonitor *zm);
308 #if 0 /* keep Emacsens' auto-indent happy */
315 /* end of gnunet_namestore_service.h */