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 * - decide what goes into storage API and what into GNS-service API
28 * - decide where to pass/expose/check keys / signatures
29 * - are GNS private keys per peer or per user?
33 #ifndef GNUNET_GNS_SERVICE_H
34 #define GNUNET_GNS_SERVICE_H
36 #include "gnunet_util_lib.h"
37 #include "gnunet_namestore_service.h"
42 #if 0 /* keep Emacsens' auto-indent happy */
49 * Connection to the GNS service.
51 struct GNUNET_GNS_Handle;
54 * Handle to control a get operation.
56 struct GNUNET_GNS_LookupHandle;
60 * Based on GNUNET_DNSPARSER_TYPEs (standard DNS)
62 enum GNUNET_GNS_RecordType
65 GNUNET_GNS_RECORD_TYPE_A = GNUNET_DNSPARSER_TYPE_A,
66 GNUNET_GNS_RECORD_TYPE_NS = GNUNET_DNSPARSER_TYPE_NS,
67 GNUNET_GNS_RECORD_TYPE_CNAME = GNUNET_DNSPARSER_TYPE_CNAME,
68 GNUNET_GNS_RECORD_TYPE_SOA = GNUNET_DNSPARSER_TYPE_SOA,
69 GNUNET_GNS_RECORD_TYPE_PTR = GNUNET_DNSPARSER_TYPE_PTR,
70 GNUNET_GNS_RECORD_MX = GNUNET_DNSPARSER_TYPE_MX,
71 GNUNET_GNS_RECORD_TXT = GNUNET_DNSPARSER_TYPE_TXT,
72 GNUNET_GNS_RECORD_AAAA = GNUNET_DNSPARSER_TYPE_AAAA,
75 GNUNET_GNS_RECORD_PKEY = GNUNET_NAMESTORE_TYPE_PKEY,
76 GNUNET_GNS_RECORD_PSEU = GNUNET_NAMESTORE_TYPE_PSEU
80 * Initialize the connection with the GNS service.
81 * FIXME: Do we need the ht_len?
83 * @param cfg configuration to use
84 * @param ht_len size of the internal hash table to use for parallel lookups
85 * @return NULL on error
87 struct GNUNET_GNS_Handle *
88 GNUNET_GNS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
93 * Shutdown connection with the GNS service.
95 * @param handle connection to shut down
98 GNUNET_GNS_disconnect (struct GNUNET_GNS_Handle *handle);
101 /* *************** Standard API: lookup ******************* */
104 * Iterator called on each result obtained for a GNS
108 * @param name "name" of the original lookup
109 * @param record the records in reply
110 * @param num_records the number of records in reply
112 typedef void (*GNUNET_GNS_LookupIterator) (void *cls,
114 const struct GNUNET_NAMESTORE_RecordData *record,
115 unsigned int num_records);
120 * Perform an asynchronous lookup operation on the GNS.
122 * @param handle handle to the GNS service
123 * @param timeout how long to wait for transmission of this request to the service
124 * // FIXME: what happens afterwards?
125 * @param name the name to look up
126 * @param type the GNUNET_GNS_RecordType to look for
127 * @param iter function to call on each result
128 * @param iter_cls closure for iter
130 * @return handle to stop the async lookup
132 struct GNUNET_GNS_LookupHandle *
133 GNUNET_GNS_lookup_start (struct GNUNET_GNS_Handle *handle,
134 struct GNUNET_TIME_Relative timeout,
136 enum GNUNET_GNS_RecordType type,
137 GNUNET_GNS_LookupIterator iter,
142 * Stop async GNS lookup. Frees associated resources.
144 * @param lookup_handle lookup operation to stop.
146 * On return lookup_handle will no longer be valid, caller
147 * must not use again!!!
150 GNUNET_GNS_lookup_stop (struct GNUNET_GNS_LookupHandle *lookup_handle);
153 #if 0 /* keep Emacsens' auto-indent happy */
162 /* gnunet_gns_service.h */