2 This file is part of GNUnet.
3 Copyright (C) 2001-2013 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @file include/gnunet_container_lib.h
23 * @brief container classes for GNUnet
24 * @author Christian Grothoff
26 * @defgroup hashmap multi hash-map
27 * @defgroup heap min- or max-heap with arbitrary element removal
28 * @defgroup bloomfilter Bloom filter (probabilistic set tests)
29 * @defgroup dll Doubly-linked list
30 * @defgroup metadata Meta data (GNU libextractor key-value pairs)
33 #ifndef GNUNET_CONTAINER_LIB_H
34 #define GNUNET_CONTAINER_LIB_H
36 /* add error and config prototypes */
37 #include "gnunet_crypto_lib.h"
38 #include <extractor.h>
40 #ifndef EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME
41 /* hack for LE < 0.6.3 */
42 #define EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME 180
48 #if 0 /* keep Emacsens' auto-indent happy */
54 /* ******************* bloomfilter ***************** */
57 * @brief bloomfilter representation (opaque)
58 * @ingroup bloomfilter
60 struct GNUNET_CONTAINER_BloomFilter;
64 * @ingroup bloomfilter
65 * Iterator over `struct GNUNET_HashCode`.
68 * @param next set to the next hash code
69 * @return #GNUNET_YES if next was updated
70 * #GNUNET_NO if there are no more entries
73 (*GNUNET_CONTAINER_HashCodeIterator) (void *cls,
74 struct GNUNET_HashCode *next);
78 * @ingroup bloomfilter
79 * Load a Bloom filter from a file.
81 * @param filename the name of the file (or the prefix)
82 * @param size the size of the bloom-filter (number of
83 * bytes of storage space to use); will be rounded up
85 * @param k the number of #GNUNET_CRYPTO_hash-functions to apply per
86 * element (number of bits set per element in the set)
87 * @return the bloomfilter
89 struct GNUNET_CONTAINER_BloomFilter *
90 GNUNET_CONTAINER_bloomfilter_load (const char *filename,
96 * @ingroup bloomfilter
97 * Create a Bloom filter from raw bits.
99 * @param data the raw bits in memory (maybe NULL,
100 * in which case all bits should be considered
102 * @param size the size of the bloom-filter (number of
103 * bytes of storage space to use); also size of @a data
104 * -- unless data is NULL. Must be a power of 2.
105 * @param k the number of #GNUNET_CRYPTO_hash-functions to apply per
106 * element (number of bits set per element in the set)
107 * @return the bloomfilter
109 struct GNUNET_CONTAINER_BloomFilter *
110 GNUNET_CONTAINER_bloomfilter_init (const char *data,
116 * @ingroup bloomfilter
117 * Copy the raw data of this Bloom filter into
118 * the given data array.
120 * @param data where to write the data
121 * @param size the size of the given @a data array
122 * @return #GNUNET_SYSERR if the data array of the wrong size
125 GNUNET_CONTAINER_bloomfilter_get_raw_data (const struct GNUNET_CONTAINER_BloomFilter *bf,
131 * @ingroup bloomfilter
132 * Test if an element is in the filter.
134 * @param e the element
135 * @param bf the filter
136 * @return #GNUNET_YES if the element is in the filter, #GNUNET_NO if not
139 GNUNET_CONTAINER_bloomfilter_test (const struct GNUNET_CONTAINER_BloomFilter *bf,
140 const struct GNUNET_HashCode *e);
144 * @ingroup bloomfilter
145 * Add an element to the filter.
147 * @param bf the filter
148 * @param e the element
151 GNUNET_CONTAINER_bloomfilter_add (struct GNUNET_CONTAINER_BloomFilter *bf,
152 const struct GNUNET_HashCode *e);
156 * @ingroup bloomfilter
157 * Remove an element from the filter.
159 * @param bf the filter
160 * @param e the element to remove
163 GNUNET_CONTAINER_bloomfilter_remove (struct GNUNET_CONTAINER_BloomFilter *bf,
164 const struct GNUNET_HashCode *e);
168 * @ingroup bloomfilter
169 * Create a copy of a bloomfilter.
171 * @param bf the filter
174 struct GNUNET_CONTAINER_BloomFilter *
175 GNUNET_CONTAINER_bloomfilter_copy (const struct GNUNET_CONTAINER_BloomFilter *bf);
180 * @ingroup bloomfilter
181 * Free the space associcated with a filter
182 * in memory, flush to drive if needed (do not
183 * free the space on the drive).
185 * @param bf the filter
188 GNUNET_CONTAINER_bloomfilter_free (struct GNUNET_CONTAINER_BloomFilter *bf);
192 * Get the number of the addresses set per element in the bloom filter.
194 * @param bf the filter
195 * @return addresses set per element in the bf
198 GNUNET_CONTAINER_bloomfilter_get_element_addresses (const struct GNUNET_CONTAINER_BloomFilter *bf);
202 * @ingroup bloomfilter
203 * Get size of the bloom filter.
205 * @param bf the filter
206 * @return number of bytes used for the data of the bloom filter
209 GNUNET_CONTAINER_bloomfilter_get_size (const struct GNUNET_CONTAINER_BloomFilter *bf);
213 * @ingroup bloomfilter
214 * Reset a Bloom filter to empty.
216 * @param bf the filter
219 GNUNET_CONTAINER_bloomfilter_clear (struct GNUNET_CONTAINER_BloomFilter *bf);
223 * @ingroup bloomfilter
224 * "or" the entries of the given raw data array with the
225 * data of the given Bloom filter. Assumes that
226 * the @a size of the @a data array and the current filter
229 * @param bf the filter
230 * @param data data to OR-in
231 * @param size size of @a data
232 * @return #GNUNET_OK on success
235 GNUNET_CONTAINER_bloomfilter_or (struct GNUNET_CONTAINER_BloomFilter *bf,
236 const char *data, size_t size);
240 * @ingroup bloomfilter
241 * "or" the entries of the given raw data array with the
242 * data of the given Bloom filter. Assumes that
243 * the size of the two filters matches.
245 * @param bf the filter
246 * @param to_or the bloomfilter to or-in
247 * @return #GNUNET_OK on success
250 GNUNET_CONTAINER_bloomfilter_or2 (struct GNUNET_CONTAINER_BloomFilter *bf,
251 const struct GNUNET_CONTAINER_BloomFilter *to_or);
255 * @ingroup bloomfilter
256 * Resize a bloom filter. Note that this operation
257 * is pretty costly. Essentially, the Bloom filter
258 * needs to be completely re-build.
260 * @param bf the filter
261 * @param iterator an iterator over all elements stored in the BF
262 * @param iterator_cls closure for @a iterator
263 * @param size the new size for the filter
264 * @param k the new number of #GNUNET_CRYPTO_hash-function to apply per element
267 GNUNET_CONTAINER_bloomfilter_resize (struct GNUNET_CONTAINER_BloomFilter *bf,
268 GNUNET_CONTAINER_HashCodeIterator iterator,
274 /* ****************** metadata ******************* */
278 * Meta data to associate with a file, directory or namespace.
280 struct GNUNET_CONTAINER_MetaData;
285 * Create a fresh meta data container.
287 * @return empty meta-data container
289 struct GNUNET_CONTAINER_MetaData *
290 GNUNET_CONTAINER_meta_data_create (void);
295 * Duplicate a MetaData token.
297 * @param md what to duplicate
298 * @return duplicate meta-data container
300 struct GNUNET_CONTAINER_MetaData *
301 GNUNET_CONTAINER_meta_data_duplicate (const struct GNUNET_CONTAINER_MetaData *md);
308 * @param md what to free
311 GNUNET_CONTAINER_meta_data_destroy (struct GNUNET_CONTAINER_MetaData *md);
316 * Test if two MDs are equal. We consider them equal if
317 * the meta types, formats and content match (we do not
318 * include the mime types and plugins names in this
321 * @param md1 first value to check
322 * @param md2 other value to check
323 * @return #GNUNET_YES if they are equal
326 GNUNET_CONTAINER_meta_data_test_equal (const struct GNUNET_CONTAINER_MetaData *md1,
327 const struct GNUNET_CONTAINER_MetaData *md2);
334 * @param md metadata to extend
335 * @param plugin_name name of the plugin that produced this value;
336 * special values can be used (i.e. '<zlib>' for zlib being
337 * used in the main libextractor library and yielding
339 * @param type libextractor-type describing the meta data
340 * @param format basic format information about data
341 * @param data_mime_type mime-type of data (not of the original file);
342 * can be NULL (if mime-type is not known)
343 * @param data actual meta-data found
344 * @param data_size number of bytes in data
345 * @return #GNUNET_OK on success, #GNUNET_SYSERR if this entry already exists
346 * data_mime_type and plugin_name are not considered for "exists" checks
349 GNUNET_CONTAINER_meta_data_insert (struct GNUNET_CONTAINER_MetaData *md,
350 const char *plugin_name,
351 enum EXTRACTOR_MetaType type,
352 enum EXTRACTOR_MetaFormat format,
353 const char *data_mime_type,
360 * Extend metadata. Merges the meta data from the second argument
361 * into the first, discarding duplicate key-value pairs.
363 * @param md metadata to extend
364 * @param in metadata to merge
367 GNUNET_CONTAINER_meta_data_merge (struct GNUNET_CONTAINER_MetaData *md,
368 const struct GNUNET_CONTAINER_MetaData *in);
375 * @param md metadata to manipulate
376 * @param type type of the item to remove
377 * @param data specific value to remove, NULL to remove all
378 * entries of the given type
379 * @param data_size number of bytes in data
380 * @return #GNUNET_OK on success, #GNUNET_SYSERR if the item does not exist in md
383 GNUNET_CONTAINER_meta_data_delete (struct GNUNET_CONTAINER_MetaData *md,
384 enum EXTRACTOR_MetaType type,
391 * Remove all items in the container.
393 * @param md metadata to manipulate
396 GNUNET_CONTAINER_meta_data_clear (struct GNUNET_CONTAINER_MetaData *md);
401 * Add the current time as the publication date
404 * @param md metadata to modify
407 GNUNET_CONTAINER_meta_data_add_publication_date (struct GNUNET_CONTAINER_MetaData *md);
412 * Iterate over MD entries.
414 * @param md metadata to inspect
415 * @param iter function to call on each entry, return 0 to continue to iterate
416 * and 1 to abort iteration in this function (GNU libextractor API!)
417 * @param iter_cls closure for @a iter
418 * @return number of entries
421 GNUNET_CONTAINER_meta_data_iterate (const struct GNUNET_CONTAINER_MetaData *md,
422 EXTRACTOR_MetaDataProcessor iter,
428 * Get the first MD entry of the given type. Caller
429 * is responsible for freeing the return value.
430 * Also, only meta data items that are strings (0-terminated)
431 * are returned by this function.
433 * @param md metadata to inspect
434 * @param type type to look for
435 * @return NULL if no entry was found
438 GNUNET_CONTAINER_meta_data_get_by_type (const struct GNUNET_CONTAINER_MetaData *md,
439 enum EXTRACTOR_MetaType type);
444 * Get the first matching MD entry of the given types. Caller is
445 * responsible for freeing the return value. Also, only meta data
446 * items that are strings (0-terminated) are returned by this
449 * @param md metadata to inspect
450 * @param ... -1-terminated list of types
451 * @return NULL if we do not have any such entry,
452 * otherwise client is responsible for freeing the value!
455 GNUNET_CONTAINER_meta_data_get_first_by_types (const struct GNUNET_CONTAINER_MetaData *md,
460 * Get a thumbnail from the meta-data (if present). Only matches meta
461 * data with mime type "image" and binary format.
463 * @param md metadata to inspect
464 * @param thumb will be set to the thumbnail data. Must be
465 * freed by the caller!
466 * @return number of bytes in thumbnail, 0 if not available
469 GNUNET_CONTAINER_meta_data_get_thumbnail (const struct GNUNET_CONTAINER_MetaData *md,
470 unsigned char **thumb);
476 * Options for metadata serialization.
478 enum GNUNET_CONTAINER_MetaDataSerializationOptions
482 * Serialize all of the data.
484 GNUNET_CONTAINER_META_DATA_SERIALIZE_FULL = 0,
488 * If not enough space is available, it is acceptable
489 * to only serialize some of the metadata.
491 GNUNET_CONTAINER_META_DATA_SERIALIZE_PART = 1,
495 * Speed is of the essence, do not allow compression.
497 GNUNET_CONTAINER_META_DATA_SERIALIZE_NO_COMPRESS = 2
503 * Serialize meta-data to target.
505 * @param md metadata to serialize
506 * @param target where to write the serialized metadata;
507 * *target can be NULL, in which case memory is allocated
508 * @param max maximum number of bytes available
509 * @param opt is it ok to just write SOME of the
510 * meta-data to match the size constraint,
511 * possibly discarding some data?
512 * @return number of bytes written on success,
513 * -1 on error (typically: not enough
517 GNUNET_CONTAINER_meta_data_serialize (const struct GNUNET_CONTAINER_MetaData *md,
520 enum GNUNET_CONTAINER_MetaDataSerializationOptions opt);
525 * Get the size of the full meta-data in serialized form.
527 * @param md metadata to inspect
528 * @return number of bytes needed for serialization, -1 on error
531 GNUNET_CONTAINER_meta_data_get_serialized_size (const struct GNUNET_CONTAINER_MetaData *md);
536 * Deserialize meta-data. Initializes md.
538 * @param input serialized meta-data.
539 * @param size number of bytes available
540 * @return MD on success, NULL on error (i.e.
543 struct GNUNET_CONTAINER_MetaData *
544 GNUNET_CONTAINER_meta_data_deserialize (const char *input,
548 /* ******************************* HashMap **************************** */
552 * Opaque handle for a HashMap.
554 struct GNUNET_CONTAINER_MultiHashMap;
558 * Opaque handle to an iterator over
561 struct GNUNET_CONTAINER_MultiHashMapIterator;
565 * Options for storing values in the HashMap.
567 enum GNUNET_CONTAINER_MultiHashMapOption
572 * If a value with the given key exists, replace it. Note that the
573 * old value would NOT be freed by replace (the application has to
574 * make sure that this happens if required).
576 GNUNET_CONTAINER_MULTIHASHMAPOPTION_REPLACE,
580 * Allow multiple values with the same key.
582 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE,
586 * There must only be one value per key; storing a value should fail
587 * if a value under the same key already exists.
589 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY,
592 * @ingroup hashmap There must only be one value per key, but don't
593 * bother checking if a value already exists (faster than
594 * #GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY; implemented
595 * just like #GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE but this
596 * option documents better what is intended if
597 * #GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY is what is
600 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST
606 * Iterator over hash map entries.
609 * @param key current key code
610 * @param value value in the hash map
611 * @return #GNUNET_YES if we should continue to
616 (*GNUNET_CONTAINER_HashMapIterator) (void *cls,
617 const struct GNUNET_HashCode *key,
623 * Create a multi hash map.
625 * @param len initial size (map will grow as needed)
626 * @param do_not_copy_keys #GNUNET_NO is always safe and should be used by default;
627 * #GNUNET_YES means that on 'put', the 'key' does not have
628 * to be copied as the destination of the pointer is
629 * guaranteed to be life as long as the value is stored in
630 * the hashmap. This can significantly reduce memory
631 * consumption, but of course is also a recipie for
632 * heap corruption if the assumption is not true. Only
633 * use this if (1) memory use is important in this case and
634 * (2) you have triple-checked that the invariant holds
635 * @return NULL on error
637 struct GNUNET_CONTAINER_MultiHashMap *
638 GNUNET_CONTAINER_multihashmap_create (unsigned int len,
639 int do_not_copy_keys);
644 * Destroy a hash map. Will not free any values
645 * stored in the hash map!
650 GNUNET_CONTAINER_multihashmap_destroy (struct GNUNET_CONTAINER_MultiHashMap *map);
655 * Given a key find a value in the map matching the key.
658 * @param key what to look for
659 * @return NULL if no value was found; note that
660 * this is indistinguishable from values that just
661 * happen to be NULL; use "contains" to test for
662 * key-value pairs with value NULL
665 GNUNET_CONTAINER_multihashmap_get (const struct GNUNET_CONTAINER_MultiHashMap *map,
666 const struct GNUNET_HashCode *key);
671 * Remove the given key-value pair from the map. Note that if the
672 * key-value pair is in the map multiple times, only one of the pairs
676 * @param key key of the key-value pair
677 * @param value value of the key-value pair
678 * @return #GNUNET_YES on success, #GNUNET_NO if the key-value pair
682 GNUNET_CONTAINER_multihashmap_remove (struct GNUNET_CONTAINER_MultiHashMap *map,
683 const struct GNUNET_HashCode *key,
688 * Remove all entries for the given key from the map.
689 * Note that the values would not be "freed".
692 * @param key identifies values to be removed
693 * @return number of values removed
696 GNUNET_CONTAINER_multihashmap_remove_all (struct GNUNET_CONTAINER_MultiHashMap *map,
697 const struct GNUNET_HashCode *key);
702 * Remove all entries from the map.
703 * Note that the values would not be "freed".
706 * @return number of values removed
709 GNUNET_CONTAINER_multihashmap_clear (struct GNUNET_CONTAINER_MultiHashMap *map);
714 * Check if the map contains any value under the given
715 * key (including values that are NULL).
718 * @param key the key to test if a value exists for it
719 * @return #GNUNET_YES if such a value exists,
723 GNUNET_CONTAINER_multihashmap_contains (const struct GNUNET_CONTAINER_MultiHashMap *map,
724 const struct GNUNET_HashCode * key);
729 * Check if the map contains the given value under the given
733 * @param key the key to test if a value exists for it
734 * @param value value to test for
735 * @return #GNUNET_YES if such a value exists,
739 GNUNET_CONTAINER_multihashmap_contains_value (const struct GNUNET_CONTAINER_MultiHashMap *map,
740 const struct GNUNET_HashCode *key,
746 * Store a key-value pair in the map.
749 * @param key key to use
750 * @param value value to use
751 * @param opt options for put
752 * @return #GNUNET_OK on success,
753 * #GNUNET_NO if a value was replaced (with REPLACE)
754 * #GNUNET_SYSERR if #GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY was the option and the
755 * value already exists
758 GNUNET_CONTAINER_multihashmap_put (struct GNUNET_CONTAINER_MultiHashMap *map,
759 const struct GNUNET_HashCode *key,
761 enum GNUNET_CONTAINER_MultiHashMapOption
766 * Get the number of key-value pairs in the map.
769 * @return the number of key value pairs
772 GNUNET_CONTAINER_multihashmap_size (const struct GNUNET_CONTAINER_MultiHashMap *map);
777 * Iterate over all entries in the map.
780 * @param it function to call on each entry
781 * @param it_cls extra argument to @a it
782 * @return the number of key value pairs processed,
783 * #GNUNET_SYSERR if it aborted iteration
786 GNUNET_CONTAINER_multihashmap_iterate (const struct GNUNET_CONTAINER_MultiHashMap *map,
787 GNUNET_CONTAINER_HashMapIterator it,
793 * Create an iterator for a multihashmap.
794 * The iterator can be used to retrieve all the elements in the multihashmap
795 * one by one, without having to handle all elements at once (in contrast to
796 * #GNUNET_CONTAINER_multihashmap_iterate). Note that the iterator can not be
797 * used anymore if elements have been removed from 'map' after the creation of
798 * the iterator, or 'map' has been destroyed. Adding elements to 'map' may
799 * result in skipped or repeated elements.
801 * @param map the map to create an iterator for
802 * @return an iterator over the given multihashmap @a map
804 struct GNUNET_CONTAINER_MultiHashMapIterator *
805 GNUNET_CONTAINER_multihashmap_iterator_create (const struct GNUNET_CONTAINER_MultiHashMap *map);
810 * Retrieve the next element from the hash map at the iterator's
811 * position. If there are no elements left, #GNUNET_NO is returned,
812 * and @a key and @a value are not modified. This operation is only
813 * allowed if no elements have been removed from the multihashmap
814 * since the creation of @a iter, and the map has not been destroyed.
815 * Adding elements may result in repeating or skipping elements.
817 * @param iter the iterator to get the next element from
818 * @param key pointer to store the key in, can be NULL
819 * @param value pointer to store the value in, can be NULL
820 * @return #GNUNET_YES we returned an element,
821 * #GNUNET_NO if we are out of elements
824 GNUNET_CONTAINER_multihashmap_iterator_next (struct GNUNET_CONTAINER_MultiHashMapIterator *iter,
825 struct GNUNET_HashCode *key,
831 * Destroy a multihashmap iterator.
833 * @param iter the iterator to destroy
836 GNUNET_CONTAINER_multihashmap_iterator_destroy (struct GNUNET_CONTAINER_MultiHashMapIterator *iter);
841 * Iterate over all entries in the map that match a particular key.
844 * @param key key that the entries must correspond to
845 * @param it function to call on each entry
846 * @param it_cls extra argument to @a it
847 * @return the number of key value pairs processed,
848 * #GNUNET_SYSERR if it aborted iteration
851 GNUNET_CONTAINER_multihashmap_get_multiple (const struct GNUNET_CONTAINER_MultiHashMap *map,
852 const struct GNUNET_HashCode *key,
853 GNUNET_CONTAINER_HashMapIterator it,
859 * Call @a it on a random value from the map, or not at all
860 * if the map is empty.
863 * @param it function to call on a random entry
864 * @param it_cls extra argument to @a it
865 * @return the number of key value pairs processed, zero or one.
868 GNUNET_CONTAINER_multihashmap_get_random (const struct GNUNET_CONTAINER_MultiHashMap *map,
869 GNUNET_CONTAINER_HashMapIterator it,
873 /* ***************** Version of Multihashmap for peer identities ****************** */
877 * Iterator over hash map entries.
880 * @param key current public key
881 * @param value value in the hash map
882 * @return #GNUNET_YES if we should continue to
887 (*GNUNET_CONTAINER_PeerMapIterator) (void *cls,
888 const struct GNUNET_PeerIdentity *key,
892 struct GNUNET_CONTAINER_MultiPeerMap;
895 * Create a multi peer map (hash map for public keys of peers).
897 * @param len initial size (map will grow as needed)
898 * @param do_not_copy_keys #GNUNET_NO is always safe and should be used by default;
899 * #GNUNET_YES means that on 'put', the 'key' does not have
900 * to be copied as the destination of the pointer is
901 * guaranteed to be life as long as the value is stored in
902 * the hashmap. This can significantly reduce memory
903 * consumption, but of course is also a recipie for
904 * heap corruption if the assumption is not true. Only
905 * use this if (1) memory use is important in this case and
906 * (2) you have triple-checked that the invariant holds
907 * @return NULL on error
909 struct GNUNET_CONTAINER_MultiPeerMap *
910 GNUNET_CONTAINER_multipeermap_create (unsigned int len,
911 int do_not_copy_keys);
916 * Destroy a hash map. Will not free any values
917 * stored in the hash map!
922 GNUNET_CONTAINER_multipeermap_destroy (struct GNUNET_CONTAINER_MultiPeerMap *map);
927 * Given a key find a value in the map matching the key.
930 * @param key what to look for
931 * @return NULL if no value was found; note that
932 * this is indistinguishable from values that just
933 * happen to be NULL; use "contains" to test for
934 * key-value pairs with value NULL
937 GNUNET_CONTAINER_multipeermap_get (const struct GNUNET_CONTAINER_MultiPeerMap *map,
938 const struct GNUNET_PeerIdentity *key);
943 * Remove the given key-value pair from the map. Note that if the
944 * key-value pair is in the map multiple times, only one of the pairs
948 * @param key key of the key-value pair
949 * @param value value of the key-value pair
950 * @return #GNUNET_YES on success, #GNUNET_NO if the key-value pair
954 GNUNET_CONTAINER_multipeermap_remove (struct GNUNET_CONTAINER_MultiPeerMap *map,
955 const struct GNUNET_PeerIdentity * key,
960 * Remove all entries for the given key from the map.
961 * Note that the values would not be "freed".
964 * @param key identifies values to be removed
965 * @return number of values removed
968 GNUNET_CONTAINER_multipeermap_remove_all (struct GNUNET_CONTAINER_MultiPeerMap *map,
969 const struct GNUNET_PeerIdentity *key);
974 * Check if the map contains any value under the given
975 * key (including values that are NULL).
978 * @param key the key to test if a value exists for it
979 * @return #GNUNET_YES if such a value exists,
983 GNUNET_CONTAINER_multipeermap_contains (const struct GNUNET_CONTAINER_MultiPeerMap *map,
984 const struct GNUNET_PeerIdentity *key);
989 * Check if the map contains the given value under the given
993 * @param key the key to test if a value exists for it
994 * @param value value to test for
995 * @return #GNUNET_YES if such a value exists,
999 GNUNET_CONTAINER_multipeermap_contains_value (const struct GNUNET_CONTAINER_MultiPeerMap *map,
1000 const struct GNUNET_PeerIdentity * key,
1006 * Store a key-value pair in the map.
1008 * @param map the map
1009 * @param key key to use
1010 * @param value value to use
1011 * @param opt options for put
1012 * @return #GNUNET_OK on success,
1013 * #GNUNET_NO if a value was replaced (with REPLACE)
1014 * #GNUNET_SYSERR if #GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY was the option and the
1015 * value already exists
1018 GNUNET_CONTAINER_multipeermap_put (struct GNUNET_CONTAINER_MultiPeerMap *map,
1019 const struct GNUNET_PeerIdentity *key,
1021 enum GNUNET_CONTAINER_MultiHashMapOption opt);
1026 * Get the number of key-value pairs in the map.
1028 * @param map the map
1029 * @return the number of key value pairs
1032 GNUNET_CONTAINER_multipeermap_size (const struct GNUNET_CONTAINER_MultiPeerMap *map);
1037 * Iterate over all entries in the map.
1039 * @param map the map
1040 * @param it function to call on each entry
1041 * @param it_cls extra argument to @a it
1042 * @return the number of key value pairs processed,
1043 * #GNUNET_SYSERR if it aborted iteration
1046 GNUNET_CONTAINER_multipeermap_iterate (const struct GNUNET_CONTAINER_MultiPeerMap *map,
1047 GNUNET_CONTAINER_PeerMapIterator it,
1051 struct GNUNET_CONTAINER_MultiPeerMapIterator;
1054 * Create an iterator for a multihashmap.
1055 * The iterator can be used to retrieve all the elements in the multihashmap
1056 * one by one, without having to handle all elements at once (in contrast to
1057 * #GNUNET_CONTAINER_multipeermap_iterate). Note that the iterator can not be
1058 * used anymore if elements have been removed from @a map after the creation of
1059 * the iterator, or 'map' has been destroyed. Adding elements to @a map may
1060 * result in skipped or repeated elements.
1062 * @param map the map to create an iterator for
1063 * @return an iterator over the given multihashmap @a map
1065 struct GNUNET_CONTAINER_MultiPeerMapIterator *
1066 GNUNET_CONTAINER_multipeermap_iterator_create (const struct GNUNET_CONTAINER_MultiPeerMap *map);
1071 * Retrieve the next element from the hash map at the iterator's
1072 * position. If there are no elements left, #GNUNET_NO is returned,
1073 * and @a key and @a value are not modified. This operation is only
1074 * allowed if no elements have been removed from the multihashmap
1075 * since the creation of @a iter, and the map has not been destroyed.
1076 * Adding elements may result in repeating or skipping elements.
1078 * @param iter the iterator to get the next element from
1079 * @param key pointer to store the key in, can be NULL
1080 * @param value pointer to store the value in, can be NULL
1081 * @return #GNUNET_YES we returned an element,
1082 * #GNUNET_NO if we are out of elements
1085 GNUNET_CONTAINER_multipeermap_iterator_next (struct GNUNET_CONTAINER_MultiPeerMapIterator *iter,
1086 struct GNUNET_PeerIdentity *key,
1087 const void **value);
1092 * Destroy a multipeermap iterator.
1094 * @param iter the iterator to destroy
1097 GNUNET_CONTAINER_multipeermap_iterator_destroy (struct GNUNET_CONTAINER_MultiPeerMapIterator *iter);
1102 * Iterate over all entries in the map that match a particular key.
1104 * @param map the map
1105 * @param key public key that the entries must correspond to
1106 * @param it function to call on each entry
1107 * @param it_cls extra argument to @a it
1108 * @return the number of key value pairs processed,
1109 * #GNUNET_SYSERR if it aborted iteration
1112 GNUNET_CONTAINER_multipeermap_get_multiple (const struct GNUNET_CONTAINER_MultiPeerMap *map,
1113 const struct GNUNET_PeerIdentity *key,
1114 GNUNET_CONTAINER_PeerMapIterator it,
1119 /* Version of multihashmap with 32 bit keys */
1123 * Opaque handle for the 32-bit key HashMap.
1125 struct GNUNET_CONTAINER_MultiHashMap32;
1130 * Opaque handle to an iterator over
1131 * a 32-bit key multihashmap.
1133 struct GNUNET_CONTAINER_MultiHashMap32Iterator;
1138 * Iterator over hash map entries.
1140 * @param cls closure
1141 * @param key current key code
1142 * @param value value in the hash map
1143 * @return #GNUNET_YES if we should continue to
1145 * #GNUNET_NO if not.
1147 typedef int (*GNUNET_CONTAINER_HashMapIterator32) (void *cls,
1154 * Create a 32-bit key multi hash map.
1156 * @param len initial size (map will grow as needed)
1157 * @return NULL on error
1159 struct GNUNET_CONTAINER_MultiHashMap32 *
1160 GNUNET_CONTAINER_multihashmap32_create (unsigned int len);
1165 * Destroy a 32-bit key hash map. Will not free any values
1166 * stored in the hash map!
1168 * @param map the map
1171 GNUNET_CONTAINER_multihashmap32_destroy (struct GNUNET_CONTAINER_MultiHashMap32
1177 * Get the number of key-value pairs in the map.
1179 * @param map the map
1180 * @return the number of key value pairs
1183 GNUNET_CONTAINER_multihashmap32_size (const struct
1184 GNUNET_CONTAINER_MultiHashMap32 *map);
1189 * Given a key find a value in the map matching the key.
1191 * @param map the map
1192 * @param key what to look for
1193 * @return NULL if no value was found; note that
1194 * this is indistinguishable from values that just
1195 * happen to be NULL; use "contains" to test for
1196 * key-value pairs with value NULL
1199 GNUNET_CONTAINER_multihashmap32_get (const struct
1200 GNUNET_CONTAINER_MultiHashMap32 *map,
1206 * Iterate over all entries in the map.
1208 * @param map the map
1209 * @param it function to call on each entry
1210 * @param it_cls extra argument to @a it
1211 * @return the number of key value pairs processed,
1212 * #GNUNET_SYSERR if it aborted iteration
1215 GNUNET_CONTAINER_multihashmap32_iterate (const struct
1216 GNUNET_CONTAINER_MultiHashMap32 *map,
1217 GNUNET_CONTAINER_HashMapIterator32 it,
1223 * Remove the given key-value pair from the map. Note that if the
1224 * key-value pair is in the map multiple times, only one of the pairs
1227 * @param map the map
1228 * @param key key of the key-value pair
1229 * @param value value of the key-value pair
1230 * @return #GNUNET_YES on success, #GNUNET_NO if the key-value pair
1234 GNUNET_CONTAINER_multihashmap32_remove (struct GNUNET_CONTAINER_MultiHashMap32 *map,
1241 * Remove all entries for the given key from the map.
1242 * Note that the values would not be "freed".
1244 * @param map the map
1245 * @param key identifies values to be removed
1246 * @return number of values removed
1249 GNUNET_CONTAINER_multihashmap32_remove_all (struct GNUNET_CONTAINER_MultiHashMap32 *map,
1255 * Check if the map contains any value under the given
1256 * key (including values that are NULL).
1258 * @param map the map
1259 * @param key the key to test if a value exists for it
1260 * @return #GNUNET_YES if such a value exists,
1264 GNUNET_CONTAINER_multihashmap32_contains (const struct GNUNET_CONTAINER_MultiHashMap32 *map,
1270 * Check if the map contains the given value under the given
1273 * @param map the map
1274 * @param key the key to test if a value exists for it
1275 * @param value value to test for
1276 * @return #GNUNET_YES if such a value exists,
1280 GNUNET_CONTAINER_multihashmap32_contains_value (const struct GNUNET_CONTAINER_MultiHashMap32 *map,
1287 * Store a key-value pair in the map.
1289 * @param map the map
1290 * @param key key to use
1291 * @param value value to use
1292 * @param opt options for put
1293 * @return #GNUNET_OK on success,
1294 * #GNUNET_NO if a value was replaced (with REPLACE)
1295 * #GNUNET_SYSERR if #GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY was the option and the
1296 * value already exists
1299 GNUNET_CONTAINER_multihashmap32_put (struct GNUNET_CONTAINER_MultiHashMap32 *map,
1302 enum GNUNET_CONTAINER_MultiHashMapOption opt);
1307 * Iterate over all entries in the map that match a particular key.
1309 * @param map the map
1310 * @param key key that the entries must correspond to
1311 * @param it function to call on each entry
1312 * @param it_cls extra argument to @a it
1313 * @return the number of key value pairs processed,
1314 * #GNUNET_SYSERR if it aborted iteration
1317 GNUNET_CONTAINER_multihashmap32_get_multiple (const struct GNUNET_CONTAINER_MultiHashMap32 *map,
1319 GNUNET_CONTAINER_HashMapIterator32 it,
1324 * Create an iterator for a 32-bit multihashmap.
1325 * The iterator can be used to retrieve all the elements in the multihashmap
1326 * one by one, without having to handle all elements at once (in contrast to
1327 * #GNUNET_CONTAINER_multihashmap32_iterate). Note that the iterator can not be
1328 * used anymore if elements have been removed from 'map' after the creation of
1329 * the iterator, or 'map' has been destroyed. Adding elements to 'map' may
1330 * result in skipped or repeated elements.
1332 * @param map the map to create an iterator for
1333 * @return an iterator over the given multihashmap map
1335 struct GNUNET_CONTAINER_MultiHashMap32Iterator *
1336 GNUNET_CONTAINER_multihashmap32_iterator_create (const struct GNUNET_CONTAINER_MultiHashMap32 *map);
1340 * Retrieve the next element from the hash map at the iterator's position.
1341 * If there are no elements left, GNUNET_NO is returned, and 'key' and 'value'
1343 * This operation is only allowed if no elements have been removed from the
1344 * multihashmap since the creation of 'iter', and the map has not been destroyed.
1345 * Adding elements may result in repeating or skipping elements.
1347 * @param iter the iterator to get the next element from
1348 * @param key pointer to store the key in, can be NULL
1349 * @param value pointer to store the value in, can be NULL
1350 * @return #GNUNET_YES we returned an element,
1351 * #GNUNET_NO if we are out of elements
1354 GNUNET_CONTAINER_multihashmap32_iterator_next (struct GNUNET_CONTAINER_MultiHashMap32Iterator *iter,
1356 const void **value);
1360 * Destroy a 32-bit multihashmap iterator.
1362 * @param iter the iterator to destroy
1365 GNUNET_CONTAINER_multihashmap32_iterator_destroy (struct GNUNET_CONTAINER_MultiHashMapIterator *iter);
1368 /* ******************** doubly-linked list *************** */
1369 /* To avoid mistakes: head->prev == tail->next == NULL */
1373 * Insert an element at the head of a DLL. Assumes that head, tail and
1374 * element are structs with prev and next fields.
1376 * @param head pointer to the head of the DLL
1377 * @param tail pointer to the tail of the DLL
1378 * @param element element to insert
1380 #define GNUNET_CONTAINER_DLL_insert(head,tail,element) do { \
1381 GNUNET_assert ( ( (element)->prev == NULL) && ((head) != (element))); \
1382 GNUNET_assert ( ( (element)->next == NULL) && ((tail) != (element))); \
1383 (element)->next = (head); \
1384 (element)->prev = NULL; \
1385 if ((tail) == NULL) \
1388 (head)->prev = element; \
1389 (head) = (element); } while (0)
1394 * Insert an element at the tail of a DLL. Assumes that head, tail and
1395 * element are structs with prev and next fields.
1397 * @param head pointer to the head of the DLL
1398 * @param tail pointer to the tail of the DLL
1399 * @param element element to insert
1401 #define GNUNET_CONTAINER_DLL_insert_tail(head,tail,element) do { \
1402 GNUNET_assert ( ( (element)->prev == NULL) && ((head) != (element))); \
1403 GNUNET_assert ( ( (element)->next == NULL) && ((tail) != (element))); \
1404 (element)->prev = (tail); \
1405 (element)->next = NULL; \
1406 if ((head) == NULL) \
1409 (tail)->next = element; \
1410 (tail) = (element); } while (0)
1415 * Insert an element into a DLL after the given other element. Insert
1416 * at the head if the other element is NULL.
1418 * @param head pointer to the head of the DLL
1419 * @param tail pointer to the tail of the DLL
1420 * @param other prior element, NULL for insertion at head of DLL
1421 * @param element element to insert
1423 #define GNUNET_CONTAINER_DLL_insert_after(head,tail,other,element) do { \
1424 GNUNET_assert ( ( (element)->prev == NULL) && ((head) != (element))); \
1425 GNUNET_assert ( ( (element)->next == NULL) && ((tail) != (element))); \
1426 (element)->prev = (other); \
1427 if (NULL == other) \
1429 (element)->next = (head); \
1430 (head) = (element); \
1434 (element)->next = (other)->next; \
1435 (other)->next = (element); \
1437 if (NULL == (element)->next) \
1438 (tail) = (element); \
1440 (element)->next->prev = (element); } while (0)
1445 * Insert an element into a DLL before the given other element. Insert
1446 * at the tail if the other element is NULL.
1448 * @param head pointer to the head of the DLL
1449 * @param tail pointer to the tail of the DLL
1450 * @param other prior element, NULL for insertion at head of DLL
1451 * @param element element to insert
1453 #define GNUNET_CONTAINER_DLL_insert_before(head,tail,other,element) do { \
1454 GNUNET_assert ( ( (element)->prev == NULL) && ((head) != (element))); \
1455 GNUNET_assert ( ( (element)->next == NULL) && ((tail) != (element))); \
1456 (element)->next = (other); \
1457 if (NULL == other) \
1459 (element)->prev = (tail); \
1460 (tail) = (element); \
1464 (element)->prev = (other)->prev; \
1465 (other)->prev = (element); \
1467 if (NULL == (element)->prev) \
1468 (head) = (element); \
1470 (element)->prev->next = (element); } while (0)
1475 * Remove an element from a DLL. Assumes that head, tail and
1476 * element point to structs with prev and next fields.
1478 * Using the head or tail pointer as the element
1479 * argument does NOT work with this macro.
1480 * Make sure to store head/tail in another pointer
1481 * and use it to remove the head or tail of the list.
1483 * @param head pointer to the head of the DLL
1484 * @param tail pointer to the tail of the DLL
1485 * @param element element to remove
1487 #define GNUNET_CONTAINER_DLL_remove(head,tail,element) do { \
1488 GNUNET_assert ( ( (element)->prev != NULL) || ((head) == (element))); \
1489 GNUNET_assert ( ( (element)->next != NULL) || ((tail) == (element))); \
1490 if ((element)->prev == NULL) \
1491 (head) = (element)->next; \
1493 (element)->prev->next = (element)->next; \
1494 if ((element)->next == NULL) \
1495 (tail) = (element)->prev; \
1497 (element)->next->prev = (element)->prev; \
1498 (element)->next = NULL; \
1499 (element)->prev = NULL; } while (0)
1502 /* ************ Multi-DLL interface, allows DLL elements to be
1503 in multiple lists at the same time *********************** */
1507 * Insert an element at the head of a MDLL. Assumes that head, tail and
1508 * element are structs with prev and next fields.
1510 * @param mdll suffix name for the next and prev pointers in the element
1511 * @param head pointer to the head of the MDLL
1512 * @param tail pointer to the tail of the MDLL
1513 * @param element element to insert
1515 #define GNUNET_CONTAINER_MDLL_insert(mdll,head,tail,element) do { \
1516 GNUNET_assert ( ( (element)->prev_##mdll == NULL) && ((head) != (element))); \
1517 GNUNET_assert ( ( (element)->next_##mdll == NULL) && ((tail) != (element))); \
1518 (element)->next_##mdll = (head); \
1519 (element)->prev_##mdll = NULL; \
1520 if ((tail) == NULL) \
1523 (head)->prev_##mdll = element; \
1524 (head) = (element); } while (0)
1529 * Insert an element at the tail of a MDLL. Assumes that head, tail and
1530 * element are structs with prev and next fields.
1532 * @param mdll suffix name for the next and prev pointers in the element
1533 * @param head pointer to the head of the MDLL
1534 * @param tail pointer to the tail of the MDLL
1535 * @param element element to insert
1537 #define GNUNET_CONTAINER_MDLL_insert_tail(mdll,head,tail,element) do { \
1538 GNUNET_assert ( ( (element)->prev_##mdll == NULL) && ((head) != (element))); \
1539 GNUNET_assert ( ( (element)->next_##mdll == NULL) && ((tail) != (element))); \
1540 (element)->prev_##mdll = (tail); \
1541 (element)->next_##mdll = NULL; \
1542 if ((head) == NULL) \
1545 (tail)->next_##mdll = element; \
1546 (tail) = (element); } while (0)
1551 * Insert an element into a MDLL after the given other element. Insert
1552 * at the head if the other element is NULL.
1554 * @param mdll suffix name for the next and prev pointers in the element
1555 * @param head pointer to the head of the MDLL
1556 * @param tail pointer to the tail of the MDLL
1557 * @param other prior element, NULL for insertion at head of MDLL
1558 * @param element element to insert
1560 #define GNUNET_CONTAINER_MDLL_insert_after(mdll,head,tail,other,element) do { \
1561 GNUNET_assert ( ( (element)->prev_##mdll == NULL) && ((head) != (element))); \
1562 GNUNET_assert ( ( (element)->next_##mdll == NULL) && ((tail) != (element))); \
1563 (element)->prev_##mdll = (other); \
1564 if (NULL == other) \
1566 (element)->next_##mdll = (head); \
1567 (head) = (element); \
1571 (element)->next_##mdll = (other)->next_##mdll; \
1572 (other)->next_##mdll = (element); \
1574 if (NULL == (element)->next_##mdll) \
1575 (tail) = (element); \
1577 (element)->next->prev_##mdll = (element); } while (0)
1582 * Insert an element into a MDLL before the given other element. Insert
1583 * at the tail if the other element is NULL.
1585 * @param mdll suffix name for the next and prev pointers in the element
1586 * @param head pointer to the head of the MDLL
1587 * @param tail pointer to the tail of the MDLL
1588 * @param other prior element, NULL for insertion at head of MDLL
1589 * @param element element to insert
1591 #define GNUNET_CONTAINER_MDLL_insert_before(mdll,head,tail,other,element) do { \
1592 GNUNET_assert ( ( (element)->prev_##mdll == NULL) && ((head) != (element))); \
1593 GNUNET_assert ( ( (element)->next_##mdll == NULL) && ((tail) != (element))); \
1594 (element)->next_##mdll = (other); \
1595 if (NULL == other) \
1597 (element)->prev = (tail); \
1598 (tail) = (element); \
1602 (element)->prev_##mdll = (other)->prev_##mdll; \
1603 (other)->prev_##mdll = (element); \
1605 if (NULL == (element)->prev_##mdll) \
1606 (head) = (element); \
1608 (element)->prev_##mdll->next_##mdll = (element); } while (0)
1613 * Remove an element from a MDLL. Assumes
1614 * that head, tail and element are structs
1615 * with prev and next fields.
1617 * @param mdll suffix name for the next and prev pointers in the element
1618 * @param head pointer to the head of the MDLL
1619 * @param tail pointer to the tail of the MDLL
1620 * @param element element to remove
1622 #define GNUNET_CONTAINER_MDLL_remove(mdll,head,tail,element) do { \
1623 GNUNET_assert ( ( (element)->prev_##mdll != NULL) || ((head) == (element))); \
1624 GNUNET_assert ( ( (element)->next_##mdll != NULL) || ((tail) == (element))); \
1625 if ((element)->prev_##mdll == NULL) \
1626 (head) = (element)->next_##mdll; \
1628 (element)->prev_##mdll->next_##mdll = (element)->next_##mdll; \
1629 if ((element)->next_##mdll == NULL) \
1630 (tail) = (element)->prev_##mdll; \
1632 (element)->next_##mdll->prev_##mdll = (element)->prev_##mdll; \
1633 (element)->next_##mdll = NULL; \
1634 (element)->prev_##mdll = NULL; } while (0)
1638 /* ******************** Heap *************** */
1643 * Cost by which elements in a heap can be ordered.
1645 typedef uint64_t GNUNET_CONTAINER_HeapCostType;
1650 * Heap type, either max or min.
1652 enum GNUNET_CONTAINER_HeapOrder
1656 * Heap with the maximum cost at the root.
1658 GNUNET_CONTAINER_HEAP_ORDER_MAX,
1662 * Heap with the minimum cost at the root.
1664 GNUNET_CONTAINER_HEAP_ORDER_MIN
1672 struct GNUNET_CONTAINER_Heap;
1677 * Handle to a node in a heap.
1679 struct GNUNET_CONTAINER_HeapNode;
1684 * Create a new heap.
1686 * @param order how should the heap be sorted?
1687 * @return handle to the heap
1689 struct GNUNET_CONTAINER_Heap *
1690 GNUNET_CONTAINER_heap_create (enum GNUNET_CONTAINER_HeapOrder order);
1695 * Destroys the heap. Only call on a heap that
1698 * @param heap heap to destroy
1701 GNUNET_CONTAINER_heap_destroy (struct GNUNET_CONTAINER_Heap *heap);
1706 * Get element stored at the root of @a heap.
1708 * @param heap Heap to inspect.
1709 * @return Element at the root, or NULL if heap is empty.
1712 GNUNET_CONTAINER_heap_peek (const struct GNUNET_CONTAINER_Heap *heap);
1716 * Get @a element and @a cost stored at the root of @a heap.
1718 * @param[in] heap Heap to inspect.
1719 * @param[out] element Root element is returned here.
1720 * @param[out] cost Cost of @a element is returned here.
1721 * @return #GNUNET_YES if an element is returned,
1722 * #GNUNET_NO if the heap is empty.
1725 GNUNET_CONTAINER_heap_peek2 (const struct GNUNET_CONTAINER_Heap *heap,
1727 GNUNET_CONTAINER_HeapCostType *cost);
1732 * Get the current size of the heap
1734 * @param heap the heap to get the size of
1735 * @return number of elements stored
1738 GNUNET_CONTAINER_heap_get_size (const struct GNUNET_CONTAINER_Heap *heap);
1743 * Get the current cost of the node
1745 * @param node the node to get the cost of
1746 * @return cost of the node
1748 GNUNET_CONTAINER_HeapCostType
1749 GNUNET_CONTAINER_heap_node_get_cost (const struct GNUNET_CONTAINER_HeapNode
1756 * @param cls closure
1757 * @param node internal node of the heap
1758 * @param element value stored at the node
1759 * @param cost cost associated with the node
1760 * @return #GNUNET_YES if we should continue to iterate,
1761 * #GNUNET_NO if not.
1763 typedef int (*GNUNET_CONTAINER_HeapIterator) (void *cls,
1764 struct GNUNET_CONTAINER_HeapNode *
1765 node, void *element,
1766 GNUNET_CONTAINER_HeapCostType
1772 * Iterate over all entries in the heap.
1774 * @param heap the heap
1775 * @param iterator function to call on each entry
1776 * @param iterator_cls closure for @a iterator
1779 GNUNET_CONTAINER_heap_iterate (const struct GNUNET_CONTAINER_Heap *heap,
1780 GNUNET_CONTAINER_HeapIterator iterator,
1781 void *iterator_cls);
1785 * Perform a random walk of the tree. The walk is biased
1786 * towards elements closer to the root of the tree (since
1787 * each walk starts at the root and ends at a random leaf).
1788 * The heap internally tracks the current position of the
1791 * @param heap heap to walk
1792 * @return data stored at the next random node in the walk;
1793 * NULL if the tree is empty.
1796 GNUNET_CONTAINER_heap_walk_get_next (struct GNUNET_CONTAINER_Heap *heap);
1801 * Inserts a new element into the heap.
1803 * @param heap heap to modify
1804 * @param element element to insert
1805 * @param cost cost for the element
1806 * @return node for the new element
1808 struct GNUNET_CONTAINER_HeapNode *
1809 GNUNET_CONTAINER_heap_insert (struct GNUNET_CONTAINER_Heap *heap, void *element,
1810 GNUNET_CONTAINER_HeapCostType cost);
1815 * Remove root of the heap.
1817 * @param heap heap to modify
1818 * @return element data stored at the root node
1821 GNUNET_CONTAINER_heap_remove_root (struct GNUNET_CONTAINER_Heap *heap);
1826 * Removes a node from the heap.
1828 * @param node node to remove
1829 * @return element data stored at the node, NULL if heap is empty
1832 GNUNET_CONTAINER_heap_remove_node (struct GNUNET_CONTAINER_HeapNode *node);
1837 * Updates the cost of any node in the tree
1839 * @param heap heap to modify
1840 * @param node node for which the cost is to be changed
1841 * @param new_cost new cost for the node
1844 GNUNET_CONTAINER_heap_update_cost (struct GNUNET_CONTAINER_Heap *heap,
1845 struct GNUNET_CONTAINER_HeapNode *node,
1846 GNUNET_CONTAINER_HeapCostType new_cost);
1849 #if 0 /* keep Emacsens' auto-indent happy */
1857 /* ifndef GNUNET_CONTAINER_LIB_H */
1859 /* end of gnunet_container_lib.h */