aboutsummaryrefslogtreecommitdiff
path: root/src/include/gnunet_dht_service.h
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2011-09-27 20:53:52 +0000
committerChristian Grothoff <christian@grothoff.org>2011-09-27 20:53:52 +0000
commit2c1f4adf15a0c5052f1835ceba460aba6acb23e4 (patch)
tree32087b0087abb5cbe04d5d04959ee78462ddd577 /src/include/gnunet_dht_service.h
parent2d10e77135a8db547c187c4aadcff8d1f1763412 (diff)
downloadgnunet-2c1f4adf15a0c5052f1835ceba460aba6acb23e4.tar.gz
gnunet-2c1f4adf15a0c5052f1835ceba460aba6acb23e4.zip
die
Diffstat (limited to 'src/include/gnunet_dht_service.h')
-rw-r--r--src/include/gnunet_dht_service.h434
1 files changed, 0 insertions, 434 deletions
diff --git a/src/include/gnunet_dht_service.h b/src/include/gnunet_dht_service.h
deleted file mode 100644
index 4a5ab7684..000000000
--- a/src/include/gnunet_dht_service.h
+++ /dev/null
@@ -1,434 +0,0 @@
1/*
2 This file is part of GNUnet
3 (C) 2004, 2005, 2006, 2008, 2009 Christian Grothoff (and other contributing authors)
4
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.
9
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.
14
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.
19 */
20
21/**
22 * @file include/gnunet_dht_service.h
23 * @brief API to the DHT service
24 * @author Christian Grothoff
25 */
26
27#ifndef GNUNET_DHT_SERVICE_H
28#define GNUNET_DHT_SERVICE_H
29
30#include "gnunet_util_lib.h"
31#include "gnunet_block_lib.h"
32#include "gnunet_hello_lib.h"
33
34#ifdef __cplusplus
35extern "C"
36{
37#if 0 /* keep Emacsens' auto-indent happy */
38}
39#endif
40#endif
41
42
43/**
44 * Default republication frequency for stored data in the DHT.
45 */
46#define GNUNET_DHT_DEFAULT_REPUBLISH_FREQUENCY GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MINUTES, 60)
47
48/**
49 * K-value that must be used for the bloom filters in 'GET'
50 * queries.
51 */
52#define GNUNET_DHT_GET_BLOOMFILTER_K GNUNET_CONSTANTS_BLOOMFILTER_K
53
54/**
55 * Non-intelligent default DHT GET replication.
56 * Should be chosen by application if anything about
57 * the network is known.
58 */
59#define DEFAULT_GET_REPLICATION 5
60
61/**
62 * Non-intelligent default DHT PUT replication.
63 * Should be chosen by application if anything about
64 * the network is known.
65 */
66#define DEFAULT_PUT_REPLICATION 8
67
68/**
69 * Connection to the DHT service.
70 */
71struct GNUNET_DHT_Handle;
72
73/**
74 * Handle to control a route operation.
75 */
76struct GNUNET_DHT_RouteHandle;
77
78/**
79 * Handle to control a get operation.
80 */
81struct GNUNET_DHT_GetHandle;
82
83/**
84 * Handle to control a find peer operation.
85 */
86struct GNUNET_DHT_FindPeerHandle;
87
88
89/**
90 * Options for routing.
91 */
92enum GNUNET_DHT_RouteOption
93{
94 /**
95 * Default. Do nothing special.
96 */
97 GNUNET_DHT_RO_NONE = 0,
98
99 /**
100 * Each peer along the way should look at 'enc' (otherwise
101 * only the k-peers closest to the key should look at it).
102 */
103 GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE = 1,
104
105 /**
106 * We should keep track of the route that the message
107 * took in the P2P network.
108 */
109 GNUNET_DHT_RO_RECORD_ROUTE = 2,
110
111 /**
112 * Possible message option for query key randomization.
113 */
114 GNUNET_DHT_RO_BART = 4,
115
116 /**
117 * This is a 'FIND-PEER' request, so approximate results are fine.
118 */
119 GNUNET_DHT_RO_FIND_PEER = 8
120};
121
122
123/**
124 * Initialize the connection with the DHT service.
125 *
126 * @param cfg configuration to use
127 * @param ht_len size of the internal hash table to use for
128 * processing multiple GET/FIND requests in parallel
129 * @return NULL on error
130 */
131struct GNUNET_DHT_Handle *
132GNUNET_DHT_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
133 unsigned int ht_len);
134
135
136/**
137 * Shutdown connection with the DHT service.
138 *
139 * @param handle connection to shut down
140 */
141void
142GNUNET_DHT_disconnect (struct GNUNET_DHT_Handle *handle);
143
144
145/* *************** Standard API: get and put ******************* */
146
147/**
148 * Perform a PUT operation storing data in the DHT.
149 *
150 * @param handle handle to DHT service
151 * @param key the key to store under
152 * @param desired_replication_level estimate of how many
153 * nearest peers this request should reach
154 * @param options routing options for this message
155 * @param type type of the value
156 * @param size number of bytes in data; must be less than 64k
157 * @param data the data to store
158 * @param exp desired expiration time for the value
159 * @param timeout how long to wait for transmission of this request
160 * @param cont continuation to call when done (transmitting request to service)
161 * @param cont_cls closure for cont
162 */
163void
164GNUNET_DHT_put (struct GNUNET_DHT_Handle *handle, const GNUNET_HashCode * key,
165 uint32_t desired_replication_level,
166 enum GNUNET_DHT_RouteOption options,
167 enum GNUNET_BLOCK_Type type, size_t size, const char *data,
168 struct GNUNET_TIME_Absolute exp,
169 struct GNUNET_TIME_Relative timeout, GNUNET_SCHEDULER_Task cont,
170 void *cont_cls);
171
172
173/**
174 * Iterator called on each result obtained for a DHT
175 * operation that expects a reply
176 *
177 * @param cls closure
178 * @param exp when will this value expire
179 * @param key key of the result
180 * @param get_path NULL-terminated array of pointers
181 * to the peers on reverse GET path (or NULL if not recorded)
182 * @param put_path NULL-terminated array of pointers
183 * to the peers on the PUT path (or NULL if not recorded)
184 * @param type type of the result
185 * @param size number of bytes in data
186 * @param data pointer to the result data
187 */
188typedef void (*GNUNET_DHT_GetIterator) (void *cls,
189 struct GNUNET_TIME_Absolute exp,
190 const GNUNET_HashCode * key,
191 const struct GNUNET_PeerIdentity *
192 const *get_path,
193 const struct GNUNET_PeerIdentity *
194 const *put_path,
195 enum GNUNET_BLOCK_Type type,
196 size_t size, const void *data);
197
198
199
200/**
201 * Perform an asynchronous GET operation on the DHT identified. See
202 * also "GNUNET_BLOCK_evaluate".
203 *
204 * @param handle handle to the DHT service
205 * @param timeout how long to wait for transmission of this request to the service
206 * @param type expected type of the response object
207 * @param key the key to look up
208 * @param desired_replication_level estimate of how many
209 nearest peers this request should reach
210 * @param options routing options for this message
211 * @param bf bloom filter associated with query (can be NULL)
212 * @param bf_mutator mutation value for bf
213 * @param xquery extended query data (can be NULL, depending on type)
214 * @param xquery_size number of bytes in xquery
215 * @param iter function to call on each result
216 * @param iter_cls closure for iter
217 *
218 * @return handle to stop the async get
219 */
220struct GNUNET_DHT_GetHandle *
221GNUNET_DHT_get_start (struct GNUNET_DHT_Handle *handle,
222 struct GNUNET_TIME_Relative timeout,
223 enum GNUNET_BLOCK_Type type, const GNUNET_HashCode * key,
224 uint32_t desired_replication_level,
225 enum GNUNET_DHT_RouteOption options,
226 const struct GNUNET_CONTAINER_BloomFilter *bf,
227 int32_t bf_mutator, const void *xquery,
228 size_t xquery_size, GNUNET_DHT_GetIterator iter,
229 void *iter_cls);
230
231
232/**
233 * Stop async DHT-get. Frees associated resources.
234 *
235 * @param get_handle GET operation to stop.
236 *
237 * On return get_handle will no longer be valid, caller
238 * must not use again!!!
239 */
240void
241GNUNET_DHT_get_stop (struct GNUNET_DHT_GetHandle *get_handle);
242
243
244/* ******** Special high-level API for finding peers *********** */
245
246/**
247 * Iterator called on each result obtained from a find peer
248 * operation
249 *
250 * @param cls closure
251 * @param peer hello of a target (peer near key)
252 */
253typedef void (*GNUNET_DHT_FindPeerProcessor) (void *cls,
254 const struct GNUNET_HELLO_Message
255 * peer);
256
257
258/**
259 * Perform an asynchronous FIND PEER operation on the DHT.
260 *
261 * @param handle handle to the DHT service
262 * @param timeout timeout for this request to be sent to the
263 * service
264 * @param key the key to look up
265 * @param options routing options for this message
266 * @param proc function to call on each result
267 * @param proc_cls closure for proc
268 * @return handle to stop the async get, NULL on error
269 */
270struct GNUNET_DHT_FindPeerHandle *
271GNUNET_DHT_find_peer_start (struct GNUNET_DHT_Handle *handle,
272 struct GNUNET_TIME_Relative timeout,
273 const GNUNET_HashCode * key,
274 enum GNUNET_DHT_RouteOption options,
275 GNUNET_DHT_FindPeerProcessor proc, void *proc_cls);
276
277
278/**
279 * Stop async find peer. Frees associated resources.
280 *
281 * @param find_peer_handle GET operation to stop.
282 */
283void
284GNUNET_DHT_find_peer_stop (struct GNUNET_DHT_FindPeerHandle *find_peer_handle);
285
286
287
288/* ***** Special low-level API providing generic routeing abstraction ***** */
289
290/**
291 * Iterator called on each result obtained from a generic route
292 * operation
293 *
294 * @param cls closure
295 * @param key key that was used
296 * @param outgoing_path NULL-terminated array of pointers
297 * to the peers on reverse outgoing
298 * path (or NULL if not recorded)
299 * to the peers on the PUT path (or NULL if not recorded)
300 * @param reply response
301 */
302typedef void (*GNUNET_DHT_ReplyProcessor) (void *cls,
303 const GNUNET_HashCode * key,
304 const struct GNUNET_PeerIdentity *
305 const *outgoing_path,
306 const struct GNUNET_MessageHeader *
307 reply);
308
309
310/**
311 * Perform an asynchronous ROUTE_START operation on the DHT.
312 *
313 * @param handle handle to the DHT service
314 * @param key the key to look up
315 * @param desired_replication_level how many peers should ultimately receive
316 * this message (advisory only, target may be too high for the
317 * given DHT or not hit exactly).
318 * @param options options for routing
319 * @param enc send the encapsulated message to a peer close to the key
320 * @param timeout when to abort with an error if we fail to get
321 * a confirmation for the request (when necessary) or how long
322 * to wait for transmission to the service; only applies
323 * if 'iter' is NULL
324 * @param iter function to call on each result, NULL if no replies are expected
325 * @param iter_cls closure for iter
326 * @param cont continuation to call when the request has been transmitted
327 * the first time to the service
328 * @param cont_cls closure for cont
329 * @return handle to stop the request, NULL if the request is "fire and forget"
330 */
331struct GNUNET_DHT_RouteHandle *
332GNUNET_DHT_route_start (struct GNUNET_DHT_Handle *handle,
333 const GNUNET_HashCode * key,
334 uint32_t desired_replication_level,
335 enum GNUNET_DHT_RouteOption options,
336 const struct GNUNET_MessageHeader *enc,
337 struct GNUNET_TIME_Relative timeout,
338 GNUNET_DHT_ReplyProcessor iter, void *iter_cls,
339 GNUNET_SCHEDULER_Task cont, void *cont_cls);
340
341
342
343/**
344 * Stop async route operation. Frees associated resources.
345 *
346 * @param route_handle operation to stop.
347 */
348void
349GNUNET_DHT_route_stop (struct GNUNET_DHT_RouteHandle *route_handle);
350
351
352/* ***** Special API for controlling DHT routing maintenance ******* */
353
354
355/**
356 * Send a message to the DHT telling it to issue a single find
357 * peer request using the peers unique identifier as key. This
358 * is used to fill the routing table, and is normally controlled
359 * by the DHT itself. However, for testing and perhaps more
360 * close control over the DHT, this can be explicitly managed.
361 *
362 * @param cont continuation to call when done (transmitting request to service)
363 * @param cont_cls closure for cont
364 * @param handle handle to the DHT service
365 */
366void
367GNUNET_DHT_find_peers (struct GNUNET_DHT_Handle *handle,
368 GNUNET_SCHEDULER_Task cont, void *cont_cls);
369
370/* ***** Special API for testing robustness with malicious peers ******* */
371
372#if HAVE_MALICIOUS
373/* Note that these functions are NOT considered to be part of the
374 "official" API and hence are NOT subjected to library versioning;
375 only developers testing GNUnet's robustness should have any use for
376 them, applications should never use them. Applications must NOT
377 define "HAVE_MALICIOUS" before including this header. */
378
379/**
380 * Send a message to the DHT telling it to start dropping
381 * all requests received.
382 *
383 * @param handle handle to the DHT service
384 * @param cont continuation to call when done (transmitting request to service)
385 * @param cont_cls closure for cont
386 *
387 */
388void
389GNUNET_DHT_set_malicious_dropper (struct GNUNET_DHT_Handle *handle,
390 GNUNET_SCHEDULER_Task cont, void *cont_cls);
391
392
393/**
394 * Send a message to the DHT telling it to start issuing random PUT
395 * requests every 'frequency' milliseconds.
396 *
397 * @param handle handle to the DHT service
398 * @param frequency delay between sending malicious messages
399 * @param cont continuation to call when done (transmitting request to service)
400 * @param cont_cls closure for cont
401 */
402void
403GNUNET_DHT_set_malicious_putter (struct GNUNET_DHT_Handle *handle,
404 struct GNUNET_TIME_Relative frequency,
405 GNUNET_SCHEDULER_Task cont, void *cont_cls);
406
407
408/**
409 * Send a message to the DHT telling it to start issuing random GET
410 * requests every 'frequency' milliseconds.
411 *
412 * @param handle handle to the DHT service
413 * @param frequency delay between sending malicious messages
414 * @param cont continuation to call when done (transmitting request to service)
415 * @param cont_cls closure for cont
416 */
417void
418GNUNET_DHT_set_malicious_getter (struct GNUNET_DHT_Handle *handle,
419 struct GNUNET_TIME_Relative frequency,
420 GNUNET_SCHEDULER_Task cont, void *cont_cls);
421
422
423#endif
424
425#if 0 /* keep Emacsens' auto-indent happy */
426{
427#endif
428#ifdef __cplusplus
429}
430#endif
431
432
433#endif
434/* gnunet_dht_service.h */