diff options
author | Christian Grothoff <christian@grothoff.org> | 2013-08-13 09:18:29 +0000 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2013-08-13 09:18:29 +0000 |
commit | 0e3f0fd50edc4e8b59fb7359c8592d91de806b86 (patch) | |
tree | 76241ea0cccf2f7c08fa31229c4c3d57418e7f9a /src/include/gnunet_namestore_service.h | |
parent | 5ec7a9372394fe793560b3cbc8b8b26dea75c694 (diff) | |
download | gnunet-0e3f0fd50edc4e8b59fb7359c8592d91de806b86.tar.gz gnunet-0e3f0fd50edc4e8b59fb7359c8592d91de806b86.zip |
-doxygen fixes
Diffstat (limited to 'src/include/gnunet_namestore_service.h')
-rw-r--r-- | src/include/gnunet_namestore_service.h | 46 |
1 files changed, 18 insertions, 28 deletions
diff --git a/src/include/gnunet_namestore_service.h b/src/include/gnunet_namestore_service.h index a1753df59..e47b1ee3d 100644 --- a/src/include/gnunet_namestore_service.h +++ b/src/include/gnunet_namestore_service.h | |||
@@ -365,7 +365,7 @@ GNUNET_NAMESTORE_zone_to_name (struct GNUNET_NAMESTORE_Handle *h, | |||
365 | * Cancel a namestore operation. The final callback from the | 365 | * Cancel a namestore operation. The final callback from the |
366 | * operation must not have been done yet. Must be called on any | 366 | * operation must not have been done yet. Must be called on any |
367 | * namestore operation that has not yet completed prior to calling | 367 | * namestore operation that has not yet completed prior to calling |
368 | * 'GNUNET_NAMESTORE_disconnect'. | 368 | * #GNUNET_NAMESTORE_disconnect. |
369 | * | 369 | * |
370 | * @param qe operation to cancel | 370 | * @param qe operation to cancel |
371 | */ | 371 | */ |
@@ -375,13 +375,11 @@ GNUNET_NAMESTORE_cancel (struct GNUNET_NAMESTORE_QueueEntry *qe); | |||
375 | 375 | ||
376 | /** | 376 | /** |
377 | * Starts a new zone iteration (used to periodically PUT all of our | 377 | * Starts a new zone iteration (used to periodically PUT all of our |
378 | * records into our DHT). "proc" will be called once immediately, and | 378 | * records into our DHT). @a proc will be called once immediately, and |
379 | * then again after "GNUNET_NAMESTORE_zone_iterator_next" is invoked. | 379 | * then again after #GNUNET_NAMESTORE_zone_iterator_next is invoked. |
380 | * | 380 | * |
381 | * @param h handle to the namestore | 381 | * @param h handle to the namestore |
382 | * @param zone zone to access | 382 | * @param zone zone to access |
383 | * @param must_have_flags flags that must be set for the record to be returned | ||
384 | * @param must_not_have_flags flags that must NOT be set for the record to be returned | ||
385 | * @param proc function to call on each name from the zone; it | 383 | * @param proc function to call on each name from the zone; it |
386 | * will be called repeatedly with a value (if available) | 384 | * will be called repeatedly with a value (if available) |
387 | * and always once at the end with a name of NULL. | 385 | * and always once at the end with a name of NULL. |
@@ -408,7 +406,7 @@ GNUNET_NAMESTORE_zone_iterator_next (struct GNUNET_NAMESTORE_ZoneIterator *it); | |||
408 | /** | 406 | /** |
409 | * Stops iteration and releases the namestore handle for further calls. Must | 407 | * Stops iteration and releases the namestore handle for further calls. Must |
410 | * be called on any iteration that has not yet completed prior to calling | 408 | * be called on any iteration that has not yet completed prior to calling |
411 | * 'GNUNET_NAMESTORE_disconnect'. | 409 | * #GNUNET_NAMESTORE_disconnect. |
412 | * | 410 | * |
413 | * @param it the iterator | 411 | * @param it the iterator |
414 | */ | 412 | */ |
@@ -441,11 +439,6 @@ typedef void (*GNUNET_NAMESTORE_RecordsSynchronizedCallback)(void *cls); | |||
441 | * the connection is re-established, the process begins from the start (all | 439 | * the connection is re-established, the process begins from the start (all |
442 | * existing records, sync, then updates). | 440 | * existing records, sync, then updates). |
443 | * | 441 | * |
444 | * Note that the 'signature' in the 'monitor' callback will always be | ||
445 | * NULL (as signatures are usually not valuable to monitoring clients, | ||
446 | * the service does not bother to generate a valid signature for | ||
447 | * monitoring). | ||
448 | * | ||
449 | * @param cfg configuration to use to connect to namestore | 442 | * @param cfg configuration to use to connect to namestore |
450 | * @param zone zone to monitor | 443 | * @param zone zone to monitor |
451 | * @param monitor function to call on zone changes | 444 | * @param monitor function to call on zone changes |
@@ -477,7 +470,7 @@ GNUNET_NAMESTORE_zone_monitor_stop (struct GNUNET_NAMESTORE_ZoneMonitor *zm); | |||
477 | * records. | 470 | * records. |
478 | * | 471 | * |
479 | * @param rd_count number of records in the rd array | 472 | * @param rd_count number of records in the rd array |
480 | * @param rd array of GNUNET_NAMESTORE_RecordData with rd_count elements | 473 | * @param rd array of #GNUNET_NAMESTORE_RecordData with @a rd_count elements |
481 | * | 474 | * |
482 | * @return the required size to serialize | 475 | * @return the required size to serialize |
483 | * | 476 | * |
@@ -491,10 +484,9 @@ GNUNET_NAMESTORE_records_get_size (unsigned int rd_count, | |||
491 | * Serialize the given records to the given destination buffer. | 484 | * Serialize the given records to the given destination buffer. |
492 | * | 485 | * |
493 | * @param rd_count number of records in the rd array | 486 | * @param rd_count number of records in the rd array |
494 | * @param rd array of GNUNET_NAMESTORE_RecordData with rd_count elements | 487 | * @param rd array of #GNUNET_NAMESTORE_RecordData with @a rd_count elements |
495 | * @param dest_size size of the destination array | 488 | * @param dest_size size of the destination array |
496 | * @param dest where to write the result | 489 | * @param dest where to write the result |
497 | * | ||
498 | * @return the size of serialized records, -1 if records do not fit | 490 | * @return the size of serialized records, -1 if records do not fit |
499 | */ | 491 | */ |
500 | ssize_t | 492 | ssize_t |
@@ -576,8 +568,8 @@ GNUNET_NAMESTORE_number_to_typename (uint32_t type); | |||
576 | * Test if a given record is expired. | 568 | * Test if a given record is expired. |
577 | * | 569 | * |
578 | * @param rd record to test | 570 | * @param rd record to test |
579 | * @return GNUNET_YES if the record is expired, | 571 | * @return #GNUNET_YES if the record is expired, |
580 | * GNUNET_NO if not | 572 | * #GNUNET_NO if not |
581 | */ | 573 | */ |
582 | int | 574 | int |
583 | GNUNET_NAMESTORE_is_expired (const struct GNUNET_NAMESTORE_RecordData *rd); | 575 | GNUNET_NAMESTORE_is_expired (const struct GNUNET_NAMESTORE_RecordData *rd); |
@@ -598,18 +590,18 @@ GNUNET_NAMESTORE_normalize_string (const char *src); | |||
598 | * NOT reentrant! | 590 | * NOT reentrant! |
599 | * | 591 | * |
600 | * @param z public key of a zone | 592 | * @param z public key of a zone |
601 | * @return string form; will be overwritten by next call to GNUNET_h2s. | 593 | * @return string form; will be overwritten by next call to #GNUNET_NAMESTORE_z2s. |
602 | */ | 594 | */ |
603 | const char * | 595 | const char * |
604 | GNUNET_NAMESTORE_z2s (const struct GNUNET_CRYPTO_EccPublicKey *z); | 596 | GNUNET_NAMESTORE_z2s (const struct GNUNET_CRYPTO_EccPublicKey *z); |
605 | 597 | ||
606 | 598 | ||
607 | /** | 599 | /** |
608 | * Calculate the DHT query for a given 'label' in a given zone. | 600 | * Calculate the DHT query for a given @a label in a given @a zone. |
609 | * | 601 | * |
610 | * @param zone private key of the zone | 602 | * @param zone private key of the zone |
611 | * @param label label of the record | 603 | * @param label label of the record |
612 | * @return query hash to use for the query | 604 | * @param query hash to use for the query |
613 | */ | 605 | */ |
614 | void | 606 | void |
615 | GNUNET_NAMESTORE_query_from_private_key (const struct GNUNET_CRYPTO_EccPrivateKey *zone, | 607 | GNUNET_NAMESTORE_query_from_private_key (const struct GNUNET_CRYPTO_EccPrivateKey *zone, |
@@ -618,11 +610,11 @@ GNUNET_NAMESTORE_query_from_private_key (const struct GNUNET_CRYPTO_EccPrivateKe | |||
618 | 610 | ||
619 | 611 | ||
620 | /** | 612 | /** |
621 | * Calculate the DHT query for a given 'label' in a given zone. | 613 | * Calculate the DHT query for a given @a label in a given @a zone. |
622 | * | 614 | * |
623 | * @param pub public key of the zone | 615 | * @param pub public key of the zone |
624 | * @param label label of the record | 616 | * @param label label of the record |
625 | * @return query hash to use for the query | 617 | * @param query hash to use for the query |
626 | */ | 618 | */ |
627 | void | 619 | void |
628 | GNUNET_NAMESTORE_query_from_public_key (const struct GNUNET_CRYPTO_EccPublicKey *pub, | 620 | GNUNET_NAMESTORE_query_from_public_key (const struct GNUNET_CRYPTO_EccPublicKey *pub, |
@@ -638,7 +630,6 @@ GNUNET_NAMESTORE_query_from_public_key (const struct GNUNET_CRYPTO_EccPublicKey | |||
638 | * @param label the name for the records | 630 | * @param label the name for the records |
639 | * @param rd record data | 631 | * @param rd record data |
640 | * @param rd_count number of records | 632 | * @param rd_count number of records |
641 | * @param signature where to store the signature | ||
642 | */ | 633 | */ |
643 | struct GNUNET_NAMESTORE_Block * | 634 | struct GNUNET_NAMESTORE_Block * |
644 | GNUNET_NAMESTORE_block_create (const struct GNUNET_CRYPTO_EccPrivateKey *key, | 635 | GNUNET_NAMESTORE_block_create (const struct GNUNET_CRYPTO_EccPrivateKey *key, |
@@ -653,7 +644,7 @@ GNUNET_NAMESTORE_block_create (const struct GNUNET_CRYPTO_EccPrivateKey *key, | |||
653 | * to validate signatures received from the network. | 644 | * to validate signatures received from the network. |
654 | * | 645 | * |
655 | * @param block block to verify | 646 | * @param block block to verify |
656 | * @return GNUNET_OK if the signature is valid | 647 | * @return #GNUNET_OK if the signature is valid |
657 | */ | 648 | */ |
658 | int | 649 | int |
659 | GNUNET_NAMESTORE_block_verify (const struct GNUNET_NAMESTORE_Block *block); | 650 | GNUNET_NAMESTORE_block_verify (const struct GNUNET_NAMESTORE_Block *block); |
@@ -667,7 +658,7 @@ GNUNET_NAMESTORE_block_verify (const struct GNUNET_NAMESTORE_Block *block); | |||
667 | * @param label the name for the records | 658 | * @param label the name for the records |
668 | * @param proc function to call with the result | 659 | * @param proc function to call with the result |
669 | * @param proc_cls closure for proc | 660 | * @param proc_cls closure for proc |
670 | * @param GNUNET_OK on success, GNUNET_SYSERR if the block was | 661 | * @return #GNUNET_OK on success, #GNUNET_SYSERR if the block was |
671 | * not well-formed | 662 | * not well-formed |
672 | */ | 663 | */ |
673 | int | 664 | int |
@@ -681,10 +672,9 @@ GNUNET_NAMESTORE_block_decrypt (const struct GNUNET_NAMESTORE_Block *block, | |||
681 | /** | 672 | /** |
682 | * Compares if two records are equal | 673 | * Compares if two records are equal |
683 | * | 674 | * |
684 | * @param a Record a | 675 | * @param a a record |
685 | * @param b Record b | 676 | * @param b another record |
686 | * | 677 | * @return #GNUNET_YES if the records are equal, or #GNUNET_NO if not. |
687 | * @return GNUNET_YES or GNUNET_NO | ||
688 | */ | 678 | */ |
689 | int | 679 | int |
690 | GNUNET_NAMESTORE_records_cmp (const struct GNUNET_NAMESTORE_RecordData *a, | 680 | GNUNET_NAMESTORE_records_cmp (const struct GNUNET_NAMESTORE_RecordData *a, |