2 This file is part of GNUnet
3 (C) 2012 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_gns_service.h
23 * @brief API to the GNS service
24 * @author Martin Schanzenbach
27 #ifndef GNUNET_GNS_SERVICE_H
28 #define GNUNET_GNS_SERVICE_H
30 #include "gnunet_util_lib.h"
35 #if 0 /* keep Emacsens' auto-indent happy */
42 * Connection to the GNS service.
44 struct GNUNET_GNS_Handle;
47 * Handle to control a get operation.
49 struct GNUNET_GNS_LookupHandle;
52 * A single GNS record.
54 struct GNUNET_GNS_Record;
59 enum GNUNET_GNS_RecordType
61 // FIXME: should be based on GNUNET_DNSPARSER_TYPE's (standard DNS),
62 // and then maybe our extensions in the area > 255?
64 GNUNET_GNS_RECORD_AAAA,
66 GNUNET_GNS_RECORD_PKEY
70 * Initialize the connection with the GNS service.
72 * @param cfg configuration to use
73 * @param ht_len size of the internal hash table to use for parallel lookups
74 * @return NULL on error
76 struct GNUNET_GNS_Handle *
77 GNUNET_GNS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg
82 * Shutdown connection with the GNS service.
84 * @param handle connection to shut down
87 GNUNET_GNS_disconnect (struct GNUNET_GNS_Handle *handle);
90 /* *************** Standard API: add and lookup ******************* */
93 * Perform an add operation storing records in the GNS.
95 * FIXME: Yes, we need this kind of API, but should it not be with the
96 * NameDataStore, rather than the GNS-service?
98 * @param handle handle to GNS service
99 * @param name the key to store under
100 * // FIXME: need to be precise here what 'name' is. Does it
101 // include '.gnunet'? What happens if we specify 'a.b.c.gnunet'
102 // but 'b.c.gnunet' has been delegated? (error?)
103 * @param desired_replication_level estimate of how many
104 * nearest peers this request should reach
105 * @param options routing options for this message
106 // FIXME: which are? where is the arg?
107 // FIXME: we should probably distinguish between 'private' and 'public'
109 * @param type type of the value
110 * @param size number of bytes in data; must be less than 64k
111 * @param data the data to store
112 // FIXME: what is the exact format of data?
113 * @param exp desired expiration time for the value
114 * @param timeout how long to wait for transmission of this request
115 * @param cont continuation to call when done (transmitting request to service)
116 * @param cont_cls closure for cont
117 * // FIXME: where are the continuations?
120 GNUNET_GNS_add_record (struct GNUNET_GNS_Handle *handle,
122 enum GNUNET_GNS_RecordType type,
123 size_t size, const char *data,
124 struct GNUNET_TIME_Absolute exp,
125 struct GNUNET_TIME_Relative timeout);
129 * Iterator called on each result obtained for a GNS
130 * operation that expects a reply TODO: eh?
134 * @param exp when will this value expire
135 * @param key key of the result
136 * // how does the key relate to the name exactly? Why not give the name?
137 * @param record the records in reply
138 * // FIXME: shouldn't this then be an array of pointers?
139 * @param num_records the number of records in reply
140 * @param type type of the result
141 * // FIXME: not in signature
143 typedef void (*GNUNET_GNS_LookupIterator) (void *cls,
144 const GNUNET_HashCode * key,
145 const struct GNUNET_GNS_Record *record,
146 unsigned int num_records);
151 * Perform an asynchronous lookup operation on the GNS.
153 * @param handle handle to the GNS service
154 * @param timeout how long to wait for transmission of this request to the service
155 * // FIXME: what happens afterwards?
156 * @param type expected type of the response object
157 * @param key the key to look up
158 * // FIXME: key, name, what format?
159 * @param desired_replication_level estimate of how many
160 nearest peers this request should reach
161 * @param options routing options for this message
162 * //FIXME: missmatch between documented and actual options...
163 * @param xquery extended query data (can be NULL, depending on type)
164 * @param xquery_size number of bytes in xquery
165 * @param iter function to call on each result
166 * @param iter_cls closure for iter
168 * @return handle to stop the async get
170 struct GNUNET_GNS_LookupHandle *
171 GNUNET_GNS_lookup_start (struct GNUNET_GNS_Handle *handle,
172 struct GNUNET_TIME_Relative timeout,
174 enum GNUNET_GNS_RecordType type,
175 GNUNET_GNS_LookupIterator iter,
180 * Stop async GNS lookup. Frees associated resources.
182 * @param lookup_handle lookup operation to stop.
184 * On return lookup_handle will no longer be valid, caller
185 * must not use again!!!
188 GNUNET_GNS_lookup_stop (struct GNUNET_GNS_LookupHandle *lookup_handle);
191 #if 0 /* keep Emacsens' auto-indent happy */
200 /* gnunet_gns_service.h */