diff options
author | Martin Schanzenbach <mschanzenbach@posteo.de> | 2012-03-22 18:20:09 +0000 |
---|---|---|
committer | Martin Schanzenbach <mschanzenbach@posteo.de> | 2012-03-22 18:20:09 +0000 |
commit | b57a34c4392be66883830b365b44afa8e1b21f6c (patch) | |
tree | b2ad53dcae67f9c11d403b6d7e44872f1b6ef005 /src | |
parent | 6ba8bbb5b9034d61ea1b54c7a6d0a670e759b6eb (diff) | |
download | gnunet-b57a34c4392be66883830b365b44afa8e1b21f6c.tar.gz gnunet-b57a34c4392be66883830b365b44afa8e1b21f6c.zip |
-doxygen
Diffstat (limited to 'src')
-rw-r--r-- | src/gns/gns_api.c | 15 | ||||
-rw-r--r-- | src/gns/gnunet-service-gns.c | 5 | ||||
-rw-r--r-- | src/gns/gnunet-service-gns_interceptor.c | 3 | ||||
-rw-r--r-- | src/gns/gnunet-service-gns_interceptor.h | 4 | ||||
-rw-r--r-- | src/gns/gnunet-service-gns_resolver.c | 18 | ||||
-rw-r--r-- | src/gns/gnunet-service-gns_resolver.h | 2 |
6 files changed, 28 insertions, 19 deletions
diff --git a/src/gns/gns_api.c b/src/gns/gns_api.c index 5733e1cf3..b0d2f3eac 100644 --- a/src/gns/gns_api.c +++ b/src/gns/gns_api.c | |||
@@ -342,9 +342,8 @@ transmit_pending (void *cls, size_t size, void *buf) | |||
342 | * Process a given reply that might match the given | 342 | * Process a given reply that might match the given |
343 | * request. | 343 | * request. |
344 | * | 344 | * |
345 | * @param cls the 'struct GNUNET_GNS_ClientResultMessage' | 345 | * @param qe a queue entry |
346 | * @param key query of the request | 346 | * @param msg the shorten msg received |
347 | * @param value the 'struct GNUNET_GNS_LookupHandle' of a request matching the same key | ||
348 | */ | 347 | */ |
349 | static void | 348 | static void |
350 | process_shorten_reply (struct GNUNET_GNS_QueueEntry *qe, | 349 | process_shorten_reply (struct GNUNET_GNS_QueueEntry *qe, |
@@ -418,11 +417,8 @@ process_get_auth_reply (struct GNUNET_GNS_QueueEntry *qe, | |||
418 | /** | 417 | /** |
419 | * Process a given reply to the lookup request | 418 | * Process a given reply to the lookup request |
420 | * | 419 | * |
421 | * @param cls the 'struct GNUNET_GNS_ClientResultMessage' | 420 | * @param qe a queue entry |
422 | * @param key query of the request | 421 | * @param msg the lookup message received |
423 | * @param value the 'struct GNUNET_GNS_LookupHandle' of a request matching the same key | ||
424 | * @return GNUNET_YES to continue to iterate over all results, | ||
425 | * GNUNET_NO if the reply is malformed | ||
426 | */ | 422 | */ |
427 | static void | 423 | static void |
428 | process_lookup_reply (struct GNUNET_GNS_QueueEntry *qe, | 424 | process_lookup_reply (struct GNUNET_GNS_QueueEntry *qe, |
@@ -587,7 +583,6 @@ process_message (void *cls, const struct GNUNET_MessageHeader *msg) | |||
587 | * Initialize the connection with the GNS service. | 583 | * Initialize the connection with the GNS service. |
588 | * | 584 | * |
589 | * @param cfg configuration to use | 585 | * @param cfg configuration to use |
590 | * @param ht_len size of the internal hash table to use for parallel requests | ||
591 | * @return handle to the GNS service, or NULL on error | 586 | * @return handle to the GNS service, or NULL on error |
592 | */ | 587 | */ |
593 | struct GNUNET_GNS_Handle * | 588 | struct GNUNET_GNS_Handle * |
@@ -610,7 +605,7 @@ GNUNET_GNS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg) | |||
610 | /** | 605 | /** |
611 | * Shutdown connection with the GNS service. | 606 | * Shutdown connection with the GNS service. |
612 | * | 607 | * |
613 | * @param handle handle of the GNS connection to stop | 608 | * @param h handle of the GNS connection to stop |
614 | */ | 609 | */ |
615 | void | 610 | void |
616 | GNUNET_GNS_disconnect (struct GNUNET_GNS_Handle *h) | 611 | GNUNET_GNS_disconnect (struct GNUNET_GNS_Handle *h) |
diff --git a/src/gns/gnunet-service-gns.c b/src/gns/gnunet-service-gns.c index dff300bb7..31b3822fb 100644 --- a/src/gns/gnunet-service-gns.c +++ b/src/gns/gnunet-service-gns.c | |||
@@ -387,8 +387,8 @@ update_zone_dht_start(void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc) | |||
387 | /** | 387 | /** |
388 | * Send shorten response back to client | 388 | * Send shorten response back to client |
389 | * | 389 | * |
390 | * @param cls the closure containing a client shorten handle | ||
390 | * @param name the shortened name result or NULL if cannot be shortened | 391 | * @param name the shortened name result or NULL if cannot be shortened |
391 | * @param csh the handle to the shorten request | ||
392 | */ | 392 | */ |
393 | static void | 393 | static void |
394 | send_shorten_response(void* cls, const char* name) | 394 | send_shorten_response(void* cls, const char* name) |
@@ -500,8 +500,8 @@ static void handle_shorten(void *cls, | |||
500 | /** | 500 | /** |
501 | * Send get authority response back to client | 501 | * Send get authority response back to client |
502 | * | 502 | * |
503 | * @param cls the closure containing a client get auth handle | ||
503 | * @param name the shortened name result or NULL if cannot be shortened | 504 | * @param name the shortened name result or NULL if cannot be shortened |
504 | * @param cah the handle to the get authority request | ||
505 | */ | 505 | */ |
506 | static void | 506 | static void |
507 | send_get_auth_response(void *cls, const char* name) | 507 | send_get_auth_response(void *cls, const char* name) |
@@ -631,7 +631,6 @@ static void handle_get_authority(void *cls, | |||
631 | * Reply to client with the result from our lookup. | 631 | * Reply to client with the result from our lookup. |
632 | * | 632 | * |
633 | * @param cls the closure (our client lookup handle) | 633 | * @param cls the closure (our client lookup handle) |
634 | * @param rh the request handle of the lookup | ||
635 | * @param rd_count the number of records | 634 | * @param rd_count the number of records |
636 | * @param rd the record data | 635 | * @param rd the record data |
637 | */ | 636 | */ |
diff --git a/src/gns/gnunet-service-gns_interceptor.c b/src/gns/gnunet-service-gns_interceptor.c index cd3aeb581..f6d56d048 100644 --- a/src/gns/gnunet-service-gns_interceptor.c +++ b/src/gns/gnunet-service-gns_interceptor.c | |||
@@ -20,7 +20,7 @@ | |||
20 | 20 | ||
21 | /** | 21 | /** |
22 | * | 22 | * |
23 | * @file gns/gns_interceptor.c | 23 | * @file gns/gnunet-service-gns_interceptor.c |
24 | * @brief GNUnet GNS interceptor logic | 24 | * @brief GNUnet GNS interceptor logic |
25 | * @author Martin Schanzenbach | 25 | * @author Martin Schanzenbach |
26 | */ | 26 | */ |
@@ -70,7 +70,6 @@ static struct GNUNET_CRYPTO_RsaPrivateKey *our_key; | |||
70 | * Reply to dns request with the result from our lookup. | 70 | * Reply to dns request with the result from our lookup. |
71 | * | 71 | * |
72 | * @param cls the closure to the request (an InterceptLookupHandle) | 72 | * @param cls the closure to the request (an InterceptLookupHandle) |
73 | * @param rh the request handle of the lookup | ||
74 | * @param rd_count the number of records to return | 73 | * @param rd_count the number of records to return |
75 | * @param rd the record data | 74 | * @param rd the record data |
76 | */ | 75 | */ |
diff --git a/src/gns/gnunet-service-gns_interceptor.h b/src/gns/gnunet-service-gns_interceptor.h index be7250b52..c3ea809f9 100644 --- a/src/gns/gnunet-service-gns_interceptor.h +++ b/src/gns/gnunet-service-gns_interceptor.h | |||
@@ -5,6 +5,7 @@ | |||
5 | * Initialize dns interceptor | 5 | * Initialize dns interceptor |
6 | * | 6 | * |
7 | * @param zone the zone | 7 | * @param zone the zone |
8 | * @param key the private key of the local zone | ||
8 | * @param c the configuration | 9 | * @param c the configuration |
9 | * @return GNUNET_YES on success GNUNET_SYSERR on error | 10 | * @return GNUNET_YES on success GNUNET_SYSERR on error |
10 | */ | 11 | */ |
@@ -13,6 +14,9 @@ gns_interceptor_init(struct GNUNET_CRYPTO_ShortHashCode zone, | |||
13 | struct GNUNET_CRYPTO_RsaPrivateKey *key, | 14 | struct GNUNET_CRYPTO_RsaPrivateKey *key, |
14 | const struct GNUNET_CONFIGURATION_Handle *c); | 15 | const struct GNUNET_CONFIGURATION_Handle *c); |
15 | 16 | ||
17 | /** | ||
18 | * Stops the interceptor | ||
19 | */ | ||
16 | void | 20 | void |
17 | gns_interceptor_stop(void){}; | 21 | gns_interceptor_stop(void){}; |
18 | 22 | ||
diff --git a/src/gns/gnunet-service-gns_resolver.c b/src/gns/gnunet-service-gns_resolver.c index c4d06e410..2bdc1bc2b 100644 --- a/src/gns/gnunet-service-gns_resolver.c +++ b/src/gns/gnunet-service-gns_resolver.c | |||
@@ -350,6 +350,7 @@ process_zone_to_name_discover(void *cls, | |||
350 | * | 350 | * |
351 | * @param name the name given by delegation | 351 | * @param name the name given by delegation |
352 | * @param zone the authority | 352 | * @param zone the authority |
353 | * @param our_zone our local zone | ||
353 | * @param the private key of our authority | 354 | * @param the private key of our authority |
354 | */ | 355 | */ |
355 | static void process_discovered_authority(char* name, | 356 | static void process_discovered_authority(char* name, |
@@ -384,6 +385,7 @@ static void process_discovered_authority(char* name, | |||
384 | * | 385 | * |
385 | * @param nh the namestore handle | 386 | * @param nh the namestore handle |
386 | * @param dh the dht handle | 387 | * @param dh the dht handle |
388 | * @param lz the local zone's hash | ||
387 | * @return GNUNET_OK on success | 389 | * @return GNUNET_OK on success |
388 | */ | 390 | */ |
389 | int | 391 | int |
@@ -408,6 +410,12 @@ gns_resolver_init(struct GNUNET_NAMESTORE_Handle *nh, | |||
408 | 410 | ||
409 | /** | 411 | /** |
410 | * Cleanup background lookups | 412 | * Cleanup background lookups |
413 | * | ||
414 | * @param cks closure to iterator | ||
415 | * @param node heap nodes | ||
416 | * @param element the resolver handle | ||
417 | * @param cost heap cost | ||
418 | * @return always GNUNET_YES | ||
411 | */ | 419 | */ |
412 | static int | 420 | static int |
413 | cleanup_pending_background_queries(void* cls, | 421 | cleanup_pending_background_queries(void* cls, |
@@ -445,7 +453,7 @@ gns_resolver_cleanup() | |||
445 | /** | 453 | /** |
446 | * Helper function to free resolver handle | 454 | * Helper function to free resolver handle |
447 | * | 455 | * |
448 | * @rh the handle to free | 456 | * @param rh the handle to free |
449 | */ | 457 | */ |
450 | static void | 458 | static void |
451 | free_resolver_handle(struct ResolverHandle* rh) | 459 | free_resolver_handle(struct ResolverHandle* rh) |
@@ -871,8 +879,9 @@ process_record_result_ns(void* cls, | |||
871 | return; | 879 | return; |
872 | } | 880 | } |
873 | 881 | ||
874 | GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Found %d answer(s) to query!\n", | 882 | GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, |
875 | rh->answered); | 883 | "Found %d answer(s) to query in %d records!\n", |
884 | rh->answered, rd_count); | ||
876 | 885 | ||
877 | rh->proc(rh->proc_cls, rh, rd_count, rd); | 886 | rh->proc(rh->proc_cls, rh, rd_count, rd); |
878 | } | 887 | } |
@@ -1406,6 +1415,7 @@ pop_tld(char* name, char* dest) | |||
1406 | * Checks if name is in tld | 1415 | * Checks if name is in tld |
1407 | * | 1416 | * |
1408 | * @param name the name to check | 1417 | * @param name the name to check |
1418 | * @param tld the TLD to check for | ||
1409 | * @return GNUNET_YES or GNUNET_NO | 1419 | * @return GNUNET_YES or GNUNET_NO |
1410 | */ | 1420 | */ |
1411 | int | 1421 | int |
@@ -1804,6 +1814,8 @@ resolve_delegation_ns(struct ResolverHandle *rh) | |||
1804 | * @param zone the root zone | 1814 | * @param zone the root zone |
1805 | * @param record_type the record type to look up | 1815 | * @param record_type the record type to look up |
1806 | * @param name the name to look up | 1816 | * @param name the name to look up |
1817 | * @param key a private key for use with PSEU import (can be NULL) | ||
1818 | * @param timeout timeout for resolution | ||
1807 | * @param proc the processor to call on result | 1819 | * @param proc the processor to call on result |
1808 | * @param cls the closure to pass to proc | 1820 | * @param cls the closure to pass to proc |
1809 | */ | 1821 | */ |
diff --git a/src/gns/gnunet-service-gns_resolver.h b/src/gns/gnunet-service-gns_resolver.h index 073c19192..a63abab9d 100644 --- a/src/gns/gnunet-service-gns_resolver.h +++ b/src/gns/gnunet-service-gns_resolver.h | |||
@@ -40,7 +40,6 @@ struct ResolverHandle; | |||
40 | * processor for a resultion result | 40 | * processor for a resultion result |
41 | * | 41 | * |
42 | * @param cls the closure | 42 | * @param cls the closure |
43 | * @param rh the resolution handle | ||
44 | * @param rd_count number of results | 43 | * @param rd_count number of results |
45 | * @pram rd resukt data | 44 | * @pram rd resukt data |
46 | */ | 45 | */ |
@@ -269,6 +268,7 @@ gns_resolver_cleanup(void); | |||
269 | * @param record_type the record type to look up | 268 | * @param record_type the record type to look up |
270 | * @param name the name to look up | 269 | * @param name the name to look up |
271 | * @param key optional private key for authority caching | 270 | * @param key optional private key for authority caching |
271 | * @param timeout timeout for the resolution | ||
272 | * @param proc the processor to call | 272 | * @param proc the processor to call |
273 | * @param cls the closure to pass to proc | 273 | * @param cls the closure to pass to proc |
274 | */ | 274 | */ |