2 This file is part of GNUnet
3 Copyright (C) 2012-2014, 2017 GNUnet e.V.
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/>.
20 * @author Martin Schanzenbach
23 * API to the GNS service
25 * @defgroup gns GNS service
28 * @see [Documentation](https://gnunet.org/gns-implementation)
32 #ifndef GNUNET_GNS_SERVICE_H
33 #define GNUNET_GNS_SERVICE_H
35 #include "gnunet_util_lib.h"
36 #include "gnunet_dnsparser_lib.h"
37 #include "gnunet_namestore_service.h"
42 #if 0 /* keep Emacsens' auto-indent happy */
49 * String we use to indicate an empty label (top-level
50 * entry in the zone). DNS uses "@", so do we.
52 #define GNUNET_GNS_EMPTY_LABEL_AT "@"
55 * Connection to the GNS service.
57 struct GNUNET_GNS_Handle;
60 * Handle to control a lookup operation.
62 struct GNUNET_GNS_LookupRequest;
65 * Handle to control a lookup operation where the
66 * TLD is resolved to a zone as part of the lookup operation.
68 struct GNUNET_GNS_LookupWithTldRequest;
72 * Initialize the connection with the GNS service.
74 * @param cfg configuration to use
75 * @return handle to the GNS service, or NULL on error
77 struct GNUNET_GNS_Handle *
78 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);
91 * Iterator called on obtained result for a GNS lookup.
94 * @param rd_count number of records in @a rd
95 * @param rd the records in reply
98 (*GNUNET_GNS_LookupResultProcessor) (void *cls,
100 const struct GNUNET_GNSRECORD_Data *rd);
104 * Options for the GNS lookup.
106 enum GNUNET_GNS_LocalOptions
109 * Defaults, look in cache, then in DHT.
111 GNUNET_GNS_LO_DEFAULT = 0,
114 * Never look in the DHT, keep request to local cache.
116 GNUNET_GNS_LO_NO_DHT = 1,
119 * For the rightmost label, only look in the cache (it
120 * is our local namestore), for the others, the DHT is OK.
122 GNUNET_GNS_LO_LOCAL_MASTER = 2
128 * Perform an asynchronous lookup operation on the GNS.
130 * @param handle handle to the GNS service
131 * @param name the name to look up
132 * @param zone zone to look in
133 * @param type the GNS record type to look for
134 * @param options local options for the lookup
135 * @param proc function to call on result
136 * @param proc_cls closure for @a proc
137 * @return handle to the queued request
139 struct GNUNET_GNS_LookupRequest *
140 GNUNET_GNS_lookup (struct GNUNET_GNS_Handle *handle,
142 const struct GNUNET_CRYPTO_EcdsaPublicKey *zone,
144 enum GNUNET_GNS_LocalOptions options,
145 GNUNET_GNS_LookupResultProcessor proc,
150 * Cancel pending lookup request
152 * @param lr the lookup request to cancel
153 * @return closure from the lookup result processor
156 GNUNET_GNS_lookup_cancel (struct GNUNET_GNS_LookupRequest *lr);
160 * Iterator called on obtained result for a GNS lookup
161 * where "not GNS" is a valid answer.
164 * @param gns_tld #GNUNET_YES if a GNS lookup was attempted,
165 * #GNUNET_NO if the TLD is not configured for GNS
166 * @param rd_count number of records in @a rd
167 * @param rd the records in the reply
170 (*GNUNET_GNS_LookupResultProcessor2) (void *cls,
173 const struct GNUNET_GNSRECORD_Data *rd);
177 * Perform an asynchronous lookup operation on the GNS,
178 * determining the zone using the TLD of the given name
179 * and the current configuration to resolve TLDs to zones.
181 * @param handle handle to the GNS service
182 * @param name the name to look up, including TLD
183 * @param type the record type to look up
184 * @param options local options for the lookup
185 * @param proc processor to call on result
186 * @param proc_cls closure for @a proc
187 * @return handle to the get request
189 struct GNUNET_GNS_LookupWithTldRequest*
190 GNUNET_GNS_lookup_with_tld (struct GNUNET_GNS_Handle *handle,
193 enum GNUNET_GNS_LocalOptions options,
194 GNUNET_GNS_LookupResultProcessor2 proc,
199 * Cancel pending lookup request
201 * @param ltr the lookup request to cancel
202 * @return closure from the lookup result processor
205 GNUNET_GNS_lookup_with_tld_cancel (struct GNUNET_GNS_LookupWithTldRequest *ltr);
208 #if 0 /* keep Emacsens' auto-indent happy */
217 /** @} */ /* end of group */