2 This file is part of GNUnet
3 Copyright (C) 2012-2014 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., 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
31 #ifndef GNUNET_GNS_SERVICE_H
32 #define GNUNET_GNS_SERVICE_H
34 #include "gnunet_util_lib.h"
35 #include "gnunet_dnsparser_lib.h"
36 #include "gnunet_namestore_service.h"
41 #if 0 /* keep Emacsens' auto-indent happy */
48 * String we use to indicate the local master zone or a
49 * root entry in the current zone.
51 #define GNUNET_GNS_MASTERZONE_STR "+"
54 * Connection to the GNS service.
56 struct GNUNET_GNS_Handle;
59 * Handle to control a lookup operation.
61 struct GNUNET_GNS_LookupRequest;
65 * Initialize the connection with the GNS service.
67 * @param cfg configuration to use
68 * @return handle to the GNS service, or NULL on error
70 struct GNUNET_GNS_Handle *
71 GNUNET_GNS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
75 * Shutdown connection with the GNS service.
77 * @param handle connection to shut down
80 GNUNET_GNS_disconnect (struct GNUNET_GNS_Handle *handle);
84 * Iterator called on obtained result for a GNS lookup.
87 * @param rd_count number of records in @a rd
88 * @param rd the records in reply
90 typedef void (*GNUNET_GNS_LookupResultProcessor) (void *cls,
92 const struct GNUNET_GNSRECORD_Data *rd);
96 * Options for the GNS lookup.
98 enum GNUNET_GNS_LocalOptions
101 * Defaults, look in cache, then in DHT.
103 GNUNET_GNS_LO_DEFAULT = 0,
106 * Never look in the DHT, keep request to local cache.
108 GNUNET_GNS_LO_NO_DHT = 1,
111 * For the rightmost label, only look in the cache (it
112 * is our master zone), for the others, the DHT is OK.
114 GNUNET_GNS_LO_LOCAL_MASTER = 2
120 * Perform an asynchronous lookup operation on the GNS.
122 * @param handle handle to the GNS service
123 * @param name the name to look up
124 * @param zone zone to look in
125 * @param type the GNS record type to look for
126 * @param options local options for the lookup
127 * @param shorten_zone_key the private key of the shorten zone (can be NULL);
128 * specify to enable automatic shortening (given a PSEU
129 * record, if a given pseudonym is not yet used in the
130 * shorten zone, we automatically add the respective zone
132 * @param proc function to call on result
133 * @param proc_cls closure for processor
134 * @return handle to the queued request
136 struct GNUNET_GNS_LookupRequest *
137 GNUNET_GNS_lookup (struct GNUNET_GNS_Handle *handle,
139 const struct GNUNET_CRYPTO_EcdsaPublicKey *zone,
141 enum GNUNET_GNS_LocalOptions options,
142 const struct GNUNET_CRYPTO_EcdsaPrivateKey *shorten_zone_key,
143 GNUNET_GNS_LookupResultProcessor proc,
148 * Cancel pending lookup request
150 * @param lr the lookup request to cancel
153 GNUNET_GNS_lookup_cancel (struct GNUNET_GNS_LookupRequest *lr);
155 /** @} */ /* end of group */
157 #if 0 /* keep Emacsens' auto-indent happy */
166 /* gnunet_gns_service.h */