2 This file is part of GNUnet
3 Copyright (C) 2012-2014 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 Martin Schanzenbach
25 * API to the GNS service
27 * @defgroup gns GNS service
30 * @see [Documentation](https://gnunet.org/gns-implementation)
34 #ifndef GNUNET_GNS_SERVICE_H
35 #define GNUNET_GNS_SERVICE_H
37 #include "gnunet_util_lib.h"
38 #include "gnunet_dnsparser_lib.h"
39 #include "gnunet_namestore_service.h"
44 #if 0 /* keep Emacsens' auto-indent happy */
51 * String we use to indicate the local master zone or a
52 * root entry in the current zone.
54 #define GNUNET_GNS_MASTERZONE_STR "+"
57 * Connection to the GNS service.
59 struct GNUNET_GNS_Handle;
62 * Handle to control a lookup operation.
64 struct GNUNET_GNS_LookupRequest;
68 * Initialize the connection with the GNS service.
70 * @param cfg configuration to use
71 * @return handle to the GNS service, or NULL on error
73 struct GNUNET_GNS_Handle *
74 GNUNET_GNS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
78 * Shutdown connection with the GNS service.
80 * @param handle connection to shut down
83 GNUNET_GNS_disconnect (struct GNUNET_GNS_Handle *handle);
87 * Iterator called on obtained result for a GNS lookup.
90 * @param rd_count number of records in @a rd
91 * @param rd the records in reply
93 typedef void (*GNUNET_GNS_LookupResultProcessor) (void *cls,
95 const struct GNUNET_GNSRECORD_Data *rd);
98 * Iterator called on obtained result for a GNS lookup.
101 * @param rd_count number of records in @a rd
102 * @param rd the records in reply
104 typedef void (*GNUNET_GNS_ReverseLookupResultProcessor) (void *cls,
109 * Options for the GNS lookup.
111 enum GNUNET_GNS_LocalOptions
114 * Defaults, look in cache, then in DHT.
116 GNUNET_GNS_LO_DEFAULT = 0,
119 * Never look in the DHT, keep request to local cache.
121 GNUNET_GNS_LO_NO_DHT = 1,
124 * For the rightmost label, only look in the cache (it
125 * is our master zone), for the others, the DHT is OK.
127 GNUNET_GNS_LO_LOCAL_MASTER = 2
133 * Perform an asynchronous lookup operation on the GNS.
135 * @param handle handle to the GNS service
136 * @param name the name to look up
137 * @param zone zone to look in
138 * @param type the GNS record type to look for
139 * @param options local options for the lookup
140 * @param shorten_zone_key the private key of the shorten zone (can be NULL);
141 * specify to enable automatic shortening (given a PSEU
142 * record, if a given pseudonym is not yet used in the
143 * shorten zone, we automatically add the respective zone
145 * @param proc function to call on result
146 * @param proc_cls closure for processor
147 * @return handle to the queued request
149 struct GNUNET_GNS_LookupRequest *
150 GNUNET_GNS_lookup (struct GNUNET_GNS_Handle *handle,
152 const struct GNUNET_CRYPTO_EcdsaPublicKey *zone,
154 enum GNUNET_GNS_LocalOptions options,
155 const struct GNUNET_CRYPTO_EcdsaPrivateKey *shorten_zone_key,
156 GNUNET_GNS_LookupResultProcessor proc,
160 * Perform an asynchronous reverse lookup operation on the GNS.
162 * @param handle handle to the GNS service
163 * @param zone_key zone to find a name for
164 * @param root_key our zone
165 * @param proc processor to call on result
166 * @param proc_cls closure for @a proc
167 * @return handle to the request
169 struct GNUNET_GNS_ReverseLookupRequest*
170 GNUNET_GNS_reverse_lookup (struct GNUNET_GNS_Handle *handle,
171 const struct GNUNET_CRYPTO_EcdsaPublicKey *zone_key,
172 const struct GNUNET_CRYPTO_EcdsaPublicKey *root_key,
173 GNUNET_GNS_ReverseLookupResultProcessor proc,
178 * Cancel pending lookup request
180 * @param lr the lookup request to cancel
183 GNUNET_GNS_lookup_cancel (struct GNUNET_GNS_LookupRequest *lr);
186 #if 0 /* keep Emacsens' auto-indent happy */
195 /** @} */ /* end of group */