aboutsummaryrefslogtreecommitdiff
path: root/src/include/gnunet_namestore_service.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/include/gnunet_namestore_service.h')
-rw-r--r--src/include/gnunet_namestore_service.h40
1 files changed, 20 insertions, 20 deletions
diff --git a/src/include/gnunet_namestore_service.h b/src/include/gnunet_namestore_service.h
index adc1a7e1d..7e39adc49 100644
--- a/src/include/gnunet_namestore_service.h
+++ b/src/include/gnunet_namestore_service.h
@@ -144,7 +144,7 @@ typedef void (*GNUNET_NAMESTORE_ContinuationWithStatus) (void *cls,
144 */ 144 */
145enum GNUNET_NAMESTORE_RecordFlags 145enum GNUNET_NAMESTORE_RecordFlags
146{ 146{
147 147
148 /** 148 /**
149 * No special options. 149 * No special options.
150 */ 150 */
@@ -251,7 +251,7 @@ struct GNUNET_NAMESTORE_Block
251 * of encrypted data that follow. 251 * of encrypted data that follow.
252 */ 252 */
253 struct GNUNET_CRYPTO_EccSignaturePurpose purpose; 253 struct GNUNET_CRYPTO_EccSignaturePurpose purpose;
254 254
255 /** 255 /**
256 * Expiration time of the block. 256 * Expiration time of the block.
257 */ 257 */
@@ -266,7 +266,7 @@ GNUNET_NETWORK_STRUCT_END
266 266
267/** 267/**
268 * Store an item in the namestore. If the item is already present, 268 * Store an item in the namestore. If the item is already present,
269 * it is replaced with the new record. 269 * it is replaced with the new record.
270 * 270 *
271 * @param h handle to the namestore 271 * @param h handle to the namestore
272 * @param block block to store 272 * @param block block to store
@@ -317,7 +317,7 @@ typedef void (*GNUNET_NAMESTORE_BlockProcessor) (void *cls,
317 317
318/** 318/**
319 * Get a result for a particular key from the namestore. The processor 319 * Get a result for a particular key from the namestore. The processor
320 * will only be called once. 320 * will only be called once.
321 * 321 *
322 * @param h handle to the namestore 322 * @param h handle to the namestore
323 * @param derived_hash hash of zone key combined with name to lookup 323 * @param derived_hash hash of zone key combined with name to lookup
@@ -328,7 +328,7 @@ typedef void (*GNUNET_NAMESTORE_BlockProcessor) (void *cls,
328 * @return a handle that can be used to cancel 328 * @return a handle that can be used to cancel
329 */ 329 */
330struct GNUNET_NAMESTORE_QueueEntry * 330struct GNUNET_NAMESTORE_QueueEntry *
331GNUNET_NAMESTORE_lookup_block (struct GNUNET_NAMESTORE_Handle *h, 331GNUNET_NAMESTORE_lookup_block (struct GNUNET_NAMESTORE_Handle *h,
332 const struct GNUNET_HashCode *derived_hash, 332 const struct GNUNET_HashCode *derived_hash,
333 GNUNET_NAMESTORE_BlockProcessor proc, void *proc_cls); 333 GNUNET_NAMESTORE_BlockProcessor proc, void *proc_cls);
334 334
@@ -363,7 +363,7 @@ typedef void (*GNUNET_NAMESTORE_RecordMonitor) (void *cls,
363 * cancel 363 * cancel
364 */ 364 */
365struct GNUNET_NAMESTORE_QueueEntry * 365struct GNUNET_NAMESTORE_QueueEntry *
366GNUNET_NAMESTORE_zone_to_name (struct GNUNET_NAMESTORE_Handle *h, 366GNUNET_NAMESTORE_zone_to_name (struct GNUNET_NAMESTORE_Handle *h,
367 const struct GNUNET_CRYPTO_EccPrivateKey *zone, 367 const struct GNUNET_CRYPTO_EccPrivateKey *zone,
368 const struct GNUNET_CRYPTO_EccPublicSignKey *value_zone, 368 const struct GNUNET_CRYPTO_EccPublicSignKey *value_zone,
369 GNUNET_NAMESTORE_RecordMonitor proc, void *proc_cls); 369 GNUNET_NAMESTORE_RecordMonitor proc, void *proc_cls);
@@ -444,7 +444,7 @@ struct GNUNET_NAMESTORE_ZoneMonitor;
444 444
445 445
446/** 446/**
447 * Function called once the monitor has caught up with the current 447 * Function called once the monitor has caught up with the current
448 * state of the database. Will be called AGAIN after each disconnect 448 * state of the database. Will be called AGAIN after each disconnect
449 * (record monitor called with 'NULL' for zone_key) once we're again 449 * (record monitor called with 'NULL' for zone_key) once we're again
450 * in sync. 450 * in sync.
@@ -534,7 +534,7 @@ GNUNET_NAMESTORE_records_deserialize (size_t len,
534 534
535 535
536/** 536/**
537 * Convert the binary value @a data of a record of 537 * Convert the binary value @a data of a record of
538 * type @a type to a human-readable string. 538 * type @a type to a human-readable string.
539 * 539 *
540 * @param type type of the record 540 * @param type type of the record
@@ -587,7 +587,7 @@ GNUNET_NAMESTORE_number_to_typename (uint32_t type);
587 587
588/** 588/**
589 * Test if a given record is expired. 589 * Test if a given record is expired.
590 * 590 *
591 * @param rd record to test 591 * @param rd record to test
592 * @return #GNUNET_YES if the record is expired, 592 * @return #GNUNET_YES if the record is expired,
593 * #GNUNET_NO if not 593 * #GNUNET_NO if not
@@ -619,11 +619,11 @@ GNUNET_NAMESTORE_z2s (const struct GNUNET_CRYPTO_EccPublicSignKey *z);
619 619
620/** 620/**
621 * Convert public key to the respective absolute domain name in the 621 * Convert public key to the respective absolute domain name in the
622 * ".zkey" pTLD. 622 * ".zkey" pTLD.
623 * This is one of the very few calls in the entire API that is 623 * This is one of the very few calls in the entire API that is
624 * NOT reentrant! 624 * NOT reentrant!
625 * 625 *
626 * @param pkey a public key with a point on the eliptic curve 626 * @param pkey a public key with a point on the eliptic curve
627 * @return string "X.zkey" where X is the coordinates of the public 627 * @return string "X.zkey" where X is the coordinates of the public
628 * key in an encoding suitable for DNS labels. 628 * key in an encoding suitable for DNS labels.
629 */ 629 */
@@ -634,10 +634,10 @@ GNUNET_NAMESTORE_pkey_to_zkey (const struct GNUNET_CRYPTO_EccPublicSignKey *pkey
634/** 634/**
635 * Convert an absolute domain name in the ".zkey" pTLD to the 635 * Convert an absolute domain name in the ".zkey" pTLD to the
636 * respective public key. 636 * respective public key.
637 * 637 *
638 * @param zkey string "X.zkey" where X is the public 638 * @param zkey string "X.zkey" where X is the public
639 * key in an encoding suitable for DNS labels. 639 * key in an encoding suitable for DNS labels.
640 * @param pkey set to a public key on the eliptic curve 640 * @param pkey set to a public key on the eliptic curve
641 * @return #GNUNET_SYSERR if @a zkey has the wrong syntax 641 * @return #GNUNET_SYSERR if @a zkey has the wrong syntax
642 */ 642 */
643int 643int
@@ -647,7 +647,7 @@ GNUNET_NAMESTORE_zkey_to_pkey (const char *zkey,
647 647
648/** 648/**
649 * Calculate the DHT query for a given @a label in a given @a zone. 649 * Calculate the DHT query for a given @a label in a given @a zone.
650 * 650 *
651 * @param zone private key of the zone 651 * @param zone private key of the zone
652 * @param label label of the record 652 * @param label label of the record
653 * @param query hash to use for the query 653 * @param query hash to use for the query
@@ -660,7 +660,7 @@ GNUNET_NAMESTORE_query_from_private_key (const struct GNUNET_CRYPTO_EccPrivateKe
660 660
661/** 661/**
662 * Calculate the DHT query for a given @a label in a given @a zone. 662 * Calculate the DHT query for a given @a label in a given @a zone.
663 * 663 *
664 * @param pub public key of the zone 664 * @param pub public key of the zone
665 * @param label label of the record 665 * @param label label of the record
666 * @param query hash to use for the query 666 * @param query hash to use for the query
@@ -707,7 +707,7 @@ GNUNET_NAMESTORE_block_verify (const struct GNUNET_NAMESTORE_Block *block);
707 * @param label the name for the records 707 * @param label the name for the records
708 * @param proc function to call with the result 708 * @param proc function to call with the result
709 * @param proc_cls closure for @a proc 709 * @param proc_cls closure for @a proc
710 * @return #GNUNET_OK on success, #GNUNET_SYSERR if the block was 710 * @return #GNUNET_OK on success, #GNUNET_SYSERR if the block was
711 * not well-formed 711 * not well-formed
712 */ 712 */
713int 713int
@@ -722,7 +722,7 @@ GNUNET_NAMESTORE_block_decrypt (const struct GNUNET_NAMESTORE_Block *block,
722 * Compares if two records are equal 722 * Compares if two records are equal
723 * 723 *
724 * @param a a record 724 * @param a a record
725 * @param b another record 725 * @param b another record
726 * @return #GNUNET_YES if the records are equal, or #GNUNET_NO if not. 726 * @return #GNUNET_YES if the records are equal, or #GNUNET_NO if not.
727 */ 727 */
728int 728int
@@ -736,11 +736,11 @@ GNUNET_NAMESTORE_records_cmp (const struct GNUNET_NAMESTORE_RecordData *a,
736 * expiration time. 736 * expiration time.
737 * 737 *
738 * @param rd_count number of records given in @a rd 738 * @param rd_count number of records given in @a rd
739 * @param rd array of records 739 * @param rd array of records
740 * @return absolute expiration time 740 * @return absolute expiration time
741 */ 741 */
742struct GNUNET_TIME_Absolute 742struct GNUNET_TIME_Absolute
743GNUNET_NAMESTORE_record_get_expiration_time (unsigned int rd_count, 743GNUNET_NAMESTORE_record_get_expiration_time (unsigned int rd_count,
744 const struct GNUNET_NAMESTORE_RecordData *rd); 744 const struct GNUNET_NAMESTORE_RecordData *rd);
745 745
746 746