1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
/*
This file is part of GNUnet
Copyright (C) 2012-2014, 2017 GNUnet e.V.
GNUnet is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published
by the Free Software Foundation, either version 3 of the License,
or (at your option) any later version.
GNUnet is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Affero General Public License for more details.
*/
/**
* @author Martin Schanzenbach
*
* @file
* API to the GNS service
*
* @defgroup gns GNS service
* GNU Name System
*
* @see [Documentation](https://gnunet.org/gns-implementation)
*
* @{
*/
#ifndef GNUNET_GNS_SERVICE_H
#define GNUNET_GNS_SERVICE_H
#include "gnunet_util_lib.h"
#include "gnunet_dnsparser_lib.h"
#include "gnunet_namestore_service.h"
#ifdef __cplusplus
extern "C"
{
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif
/**
* String we use to indicate an empty label (top-level
* entry in the zone). DNS uses "@", so do we.
*/
#define GNUNET_GNS_EMPTY_LABEL_AT "@"
/**
* Connection to the GNS service.
*/
struct GNUNET_GNS_Handle;
/**
* Handle to control a lookup operation.
*/
struct GNUNET_GNS_LookupRequest;
/**
* Handle to control a lookup operation where the
* TLD is resolved to a zone as part of the lookup operation.
*/
struct GNUNET_GNS_LookupWithTldRequest;
/**
* Initialize the connection with the GNS service.
*
* @param cfg configuration to use
* @return handle to the GNS service, or NULL on error
*/
struct GNUNET_GNS_Handle *
GNUNET_GNS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
/**
* Shutdown connection with the GNS service.
*
* @param handle connection to shut down
*/
void
GNUNET_GNS_disconnect (struct GNUNET_GNS_Handle *handle);
/**
* Iterator called on obtained result for a GNS lookup.
*
* @param cls closure
* @param rd_count number of records in @a rd
* @param rd the records in reply
*/
typedef void
(*GNUNET_GNS_LookupResultProcessor) (void *cls,
uint32_t rd_count,
const struct GNUNET_GNSRECORD_Data *rd);
/**
* Options for the GNS lookup.
*/
enum GNUNET_GNS_LocalOptions
{
/**
* Defaults, look in cache, then in DHT.
*/
GNUNET_GNS_LO_DEFAULT = 0,
/**
* Never look in the DHT, keep request to local cache.
*/
GNUNET_GNS_LO_NO_DHT = 1,
/**
* For the rightmost label, only look in the cache (it
* is our local namestore), for the others, the DHT is OK.
*/
GNUNET_GNS_LO_LOCAL_MASTER = 2
};
/**
* Perform an asynchronous lookup operation on the GNS.
*
* @param handle handle to the GNS service
* @param name the name to look up
* @param zone zone to look in
* @param type the GNS record type to look for
* @param options local options for the lookup
* @param proc function to call on result
* @param proc_cls closure for @a proc
* @return handle to the queued request
*/
struct GNUNET_GNS_LookupRequest *
GNUNET_GNS_lookup (struct GNUNET_GNS_Handle *handle,
const char *name,
const struct GNUNET_CRYPTO_EcdsaPublicKey *zone,
uint32_t type,
enum GNUNET_GNS_LocalOptions options,
GNUNET_GNS_LookupResultProcessor proc,
void *proc_cls);
/**
* Cancel pending lookup request
*
* @param lr the lookup request to cancel
*/
void
GNUNET_GNS_lookup_cancel (struct GNUNET_GNS_LookupRequest *lr);
/**
* Iterator called on obtained result for a GNS lookup
* where "not GNS" is a valid answer.
*
* @param cls closure
* @param gns_tld #GNUNET_YES if a GNS lookup was attempted,
* #GNUNET_NO if the TLD is not configured for GNS
* @param rd_count number of records in @a rd
* @param rd the records in the reply
*/
typedef void
(*GNUNET_GNS_LookupResultProcessor2) (void *cls,
int gns_tld,
uint32_t rd_count,
const struct GNUNET_GNSRECORD_Data *rd);
/**
* Perform an asynchronous lookup operation on the GNS,
* determining the zone using the TLD of the given name
* and the current configuration to resolve TLDs to zones.
*
* @param handle handle to the GNS service
* @param name the name to look up, including TLD
* @param type the record type to look up
* @param options local options for the lookup
* @param proc processor to call on result
* @param proc_cls closure for @a proc
* @return handle to the get request
*/
struct GNUNET_GNS_LookupWithTldRequest*
GNUNET_GNS_lookup_with_tld (struct GNUNET_GNS_Handle *handle,
const char *name,
uint32_t type,
enum GNUNET_GNS_LocalOptions options,
GNUNET_GNS_LookupResultProcessor2 proc,
void *proc_cls);
/**
* Cancel pending lookup request
*
* @param ltr the lookup request to cancel
*/
void
GNUNET_GNS_lookup_with_tld_cancel (struct GNUNET_GNS_LookupWithTldRequest *ltr);
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
#endif
/** @} */ /* end of group */
|
