2 This file is part of GNUnet.
3 (C) 2001, 2002, 2003, 2004, 2005, 2006, 2008, 2009, 2010 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 2, 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
25 * @author Christian Grothoff
29 #ifndef GNUNET_CONTAINER_LIB_H
30 #define GNUNET_CONTAINER_LIB_H
32 /* add error and config prototypes */
33 #include "gnunet_crypto_lib.h"
34 #include <extractor.h>
39 #if 0 /* keep Emacsens' auto-indent happy */
45 /* ******************* bloomfilter ***************** */
48 * @brief bloomfilter representation (opaque)
50 struct GNUNET_CONTAINER_BloomFilter;
53 * Iterator over HashCodes.
56 * @param next set to the next hash code
57 * @return GNUNET_YES if next was updated
58 * GNUNET_NO if there are no more entries
60 typedef int (*GNUNET_HashCodeIterator) (void *cls,
61 GNUNET_HashCode * next);
64 * Load a bloom-filter from a file.
66 * @param filename the name of the file (or the prefix)
67 * @param size the size of the bloom-filter (number of
68 * bytes of storage space to use)
69 * @param k the number of GNUNET_CRYPTO_hash-functions to apply per
70 * element (number of bits set per element in the set)
71 * @return the bloomfilter
73 struct GNUNET_CONTAINER_BloomFilter *
74 GNUNET_CONTAINER_bloomfilter_load (const
84 * Create a bloom filter from raw bits.
86 * @param data the raw bits in memory (maybe NULL,
87 * in which case all bits should be considered
89 * @param size the size of the bloom-filter (number of
90 * bytes of storage space to use); also size of data
91 * -- unless data is NULL. Must be a power of 2.
92 * @param k the number of GNUNET_CRYPTO_hash-functions to apply per
93 * element (number of bits set per element in the set)
94 * @return the bloomfilter
96 struct GNUNET_CONTAINER_BloomFilter *
97 GNUNET_CONTAINER_bloomfilter_init (const
107 * Copy the raw data of this bloomfilter into
108 * the given data array.
110 * @param data where to write the data
111 * @param size the size of the given data array
112 * @return GNUNET_SYSERR if the data array of the wrong size
114 int GNUNET_CONTAINER_bloomfilter_get_raw_data (struct
115 GNUNET_CONTAINER_BloomFilter
120 * Test if an element is in the filter.
121 * @param e the element
122 * @param bf the filter
123 * @return GNUNET_YES if the element is in the filter, GNUNET_NO if not
125 int GNUNET_CONTAINER_bloomfilter_test (struct GNUNET_CONTAINER_BloomFilter
126 *bf, const GNUNET_HashCode * e);
129 * Add an element to the filter
130 * @param bf the filter
131 * @param e the element
133 void GNUNET_CONTAINER_bloomfilter_add (struct GNUNET_CONTAINER_BloomFilter
134 *bf, const GNUNET_HashCode * e);
137 * Remove an element from the filter.
138 * @param bf the filter
139 * @param e the element to remove
141 void GNUNET_CONTAINER_bloomfilter_remove (struct GNUNET_CONTAINER_BloomFilter
142 *bf, const GNUNET_HashCode * e);
145 * Free the space associcated with a filter
146 * in memory, flush to drive if needed (do not
147 * free the space on the drive)
148 * @param bf the filter
150 void GNUNET_CONTAINER_bloomfilter_free (struct GNUNET_CONTAINER_BloomFilter
154 * Reset a bloom filter to empty.
155 * @param bf the filter
157 void GNUNET_CONTAINER_bloomfilter_clear (struct GNUNET_CONTAINER_BloomFilter
161 * Or the entries of the given raw data array with the
162 * data of the given bloom filter. Assumes that
163 * the size of the data array and the current filter
166 * @param bf the filter
167 * @param data data to OR-in
168 * @param size size of data
169 * @return GNUNET_OK on success
171 int GNUNET_CONTAINER_bloomfilter_or (struct GNUNET_CONTAINER_BloomFilter *bf,
172 const char *data, size_t size);
175 * Or the entries of the given raw data array with the
176 * data of the given bloom filter. Assumes that
177 * the size of the data array and the current filter
180 * @param bf the filter
181 * @param to_or the bloomfilter to or-in
182 * @param size number of bytes in data
185 GNUNET_CONTAINER_bloomfilter_or2 (struct GNUNET_CONTAINER_BloomFilter *bf,
186 const struct GNUNET_CONTAINER_BloomFilter *to_or,
190 * Resize a bloom filter. Note that this operation
191 * is pretty costly. Essentially, the bloom filter
192 * needs to be completely re-build.
194 * @param bf the filter
195 * @param iterator an iterator over all elements stored in the BF
196 * @param iterator_cls closure for iterator
197 * @param size the new size for the filter
198 * @param k the new number of GNUNET_CRYPTO_hash-function to apply per element
200 void GNUNET_CONTAINER_bloomfilter_resize (struct GNUNET_CONTAINER_BloomFilter
202 GNUNET_HashCodeIterator iterator,
204 size_t size, unsigned int k);
206 /* ****************** metadata ******************* */
209 * Meta data to associate with a file, directory or namespace.
211 struct GNUNET_CONTAINER_MetaData;
214 * Create a fresh MetaData token.
216 * @return empty meta-data container
218 struct GNUNET_CONTAINER_MetaData *
219 GNUNET_CONTAINER_meta_data_create (void);
222 * Duplicate a MetaData token.
224 * @param md what to duplicate
225 * @return duplicate meta-data container
227 struct GNUNET_CONTAINER_MetaData *
228 GNUNET_CONTAINER_meta_data_duplicate (const struct
229 GNUNET_CONTAINER_MetaData *md);
234 * @param md what to free
237 GNUNET_CONTAINER_meta_data_destroy (struct GNUNET_CONTAINER_MetaData *md);
240 * Test if two MDs are equal. We consider them equal if
241 * the meta types, formats and content match (we do not
242 * include the mime types and plugins names in this
245 * @param md1 first value to check
246 * @param md2 other value to check
247 * @return GNUNET_YES if they are equal
250 GNUNET_CONTAINER_meta_data_test_equal (const struct
251 GNUNET_CONTAINER_MetaData *md1,
253 GNUNET_CONTAINER_MetaData *md2);
259 * @param md metadata to extend
260 * @param plugin_name name of the plugin that produced this value;
261 * special values can be used (i.e. '<zlib>' for zlib being
262 * used in the main libextractor library and yielding
264 * @param type libextractor-type describing the meta data
265 * @param format basic format information about data
266 * @param data_mime_type mime-type of data (not of the original file);
267 * can be NULL (if mime-type is not known)
268 * @param data actual meta-data found
269 * @param data_len number of bytes in data
270 * @return GNUNET_OK on success, GNUNET_SYSERR if this entry already exists
271 * data_mime_type and plugin_name are not considered for "exists" checks
274 GNUNET_CONTAINER_meta_data_insert (struct GNUNET_CONTAINER_MetaData *md,
275 const char *plugin_name,
276 enum EXTRACTOR_MetaType type,
277 enum EXTRACTOR_MetaFormat format,
278 const char *data_mime_type,
284 * Extend metadata. Merges the meta data from the second argument
285 * into the first, discarding duplicate key-value pairs.
287 * @param md metadata to extend
288 * @param in metadata to merge
291 GNUNET_CONTAINER_meta_data_merge (struct GNUNET_CONTAINER_MetaData *md,
292 const struct GNUNET_CONTAINER_MetaData *in);
298 * @param md metadata to manipulate
299 * @param type type of the item to remove
300 * @param data specific value to remove, NULL to remove all
301 * entries of the given type
302 * @param data_len number of bytes in data
303 * @return GNUNET_OK on success, GNUNET_SYSERR if the item does not exist in md
306 GNUNET_CONTAINER_meta_data_delete (struct GNUNET_CONTAINER_MetaData *md,
307 enum EXTRACTOR_MetaType type,
313 * Remove all items in the container.
315 * @param md metadata to manipulate
318 GNUNET_CONTAINER_meta_data_clear (struct GNUNET_CONTAINER_MetaData *md);
322 * Add the current time as the publication date
325 * @param md metadata to modify
328 GNUNET_CONTAINER_meta_data_add_publication_date (struct
329 GNUNET_CONTAINER_MetaData
334 * Iterate over MD entries.
336 * @param md metadata to inspect
337 * @param iter function to call on each entry
338 * @param iter_cls closure for iterator
339 * @return number of entries
341 int GNUNET_CONTAINER_meta_data_iterate (const struct
342 GNUNET_CONTAINER_MetaData *md,
343 EXTRACTOR_MetaDataProcessor
344 iter, void *iter_cls);
347 * Get the first MD entry of the given type. Caller
348 * is responsible for freeing the return value.
349 * Also, only meta data items that are strings (0-terminated)
350 * are returned by this function.
352 * @param md metadata to inspect
353 * @param type type to look for
354 * @return NULL if no entry was found
357 GNUNET_CONTAINER_meta_data_get_by_type (const struct
358 GNUNET_CONTAINER_MetaData *md,
359 enum EXTRACTOR_MetaType type);
363 * Get the first matching MD entry of the given types. Caller is
364 * responsible for freeing the return value. Also, only meta data
365 * items that are strings (0-terminated) are returned by this
368 * @param md metadata to inspect
369 * @param ... -1-terminated list of types
370 * @return NULL if we do not have any such entry,
371 * otherwise client is responsible for freeing the value!
374 GNUNET_CONTAINER_meta_data_get_first_by_types (const struct
375 GNUNET_CONTAINER_MetaData
379 * Get a thumbnail from the meta-data (if present). Only matches meta
380 * data with mime type "image" and binary format.
382 * @param md metadata to inspect
383 * @param thumb will be set to the thumbnail data. Must be
384 * freed by the caller!
385 * @return number of bytes in thumbnail, 0 if not available
388 GNUNET_CONTAINER_meta_data_get_thumbnail (const struct
389 GNUNET_CONTAINER_MetaData
390 *md, unsigned char **thumb);
395 * Options for metadata serialization.
397 enum GNUNET_CONTAINER_MetaDataSerializationOptions
400 * Serialize all of the data.
402 GNUNET_CONTAINER_META_DATA_SERIALIZE_FULL = 0,
405 * If not enough space is available, it is acceptable
406 * to only serialize some of the metadata.
408 GNUNET_CONTAINER_META_DATA_SERIALIZE_PART = 1,
411 * Speed is of the essence, do not allow compression.
413 GNUNET_CONTAINER_META_DATA_SERIALIZE_NO_COMPRESS = 2
418 * Serialize meta-data to target.
420 * @param md metadata to serialize
421 * @param target where to write the serialized metadata;
422 * *target can be NULL, in which case memory is allocated
423 * @param max maximum number of bytes available
424 * @param opt is it ok to just write SOME of the
425 * meta-data to match the size constraint,
426 * possibly discarding some data?
427 * @return number of bytes written on success,
428 * -1 on error (typically: not enough
431 ssize_t GNUNET_CONTAINER_meta_data_serialize (const struct
432 GNUNET_CONTAINER_MetaData *md,
436 GNUNET_CONTAINER_MetaDataSerializationOptions
441 * Get the size of the full meta-data in serialized form.
443 * @param md metadata to inspect
444 * @return number of bytes needed for serialization, -1 on error
446 ssize_t GNUNET_CONTAINER_meta_data_get_serialized_size (const struct
447 GNUNET_CONTAINER_MetaData
452 * Deserialize meta-data. Initializes md.
454 * @param input serialized meta-data.
455 * @param size number of bytes available
456 * @return MD on success, NULL on error (i.e.
459 struct GNUNET_CONTAINER_MetaData
460 *GNUNET_CONTAINER_meta_data_deserialize (const char *input,
464 /* ******************************* HashMap **************************** */
467 * Opaque handle for a HashMap.
469 struct GNUNET_CONTAINER_MultiHashMap;
472 * Options for storing values in the HashMap.
474 enum GNUNET_CONTAINER_MultiHashMapOption
478 * If a value with the given key exists, replace it. Note that the
479 * old value would NOT be freed by replace (the application has to
480 * make sure that this happens if required).
482 GNUNET_CONTAINER_MULTIHASHMAPOPTION_REPLACE,
485 * Allow multiple values with the same key.
487 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE,
490 * There must only be one value per key; storing a value should fail
491 * if a value under the same key already exists.
493 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY,
496 * There must only be one value per key, but don't bother checking
497 * if a value already exists (faster than UNIQUE_ONLY; implemented
498 * just like MULTIPLE but this option documents better what is
499 * intended if UNIQUE is what is desired).
501 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST
506 * Iterator over hash map entries.
509 * @param key current key code
510 * @param value value in the hash map
511 * @return GNUNET_YES if we should continue to
515 typedef int (*GNUNET_CONTAINER_HashMapIterator) (void *cls,
516 const GNUNET_HashCode * key,
521 * Create a multi hash map.
523 * @param len initial size (map will grow as needed)
524 * @return NULL on error
526 struct GNUNET_CONTAINER_MultiHashMap
527 *GNUNET_CONTAINER_multihashmap_create (unsigned int len);
531 * Destroy a hash map. Will not free any values
532 * stored in the hash map!
536 void GNUNET_CONTAINER_multihashmap_destroy (struct
537 GNUNET_CONTAINER_MultiHashMap
542 * Given a key find a value in the map matching the key.
545 * @param key what to look for
546 * @return NULL if no value was found; note that
547 * this is indistinguishable from values that just
548 * happen to be NULL; use "contains" to test for
549 * key-value pairs with value NULL
551 void *GNUNET_CONTAINER_multihashmap_get (const struct
552 GNUNET_CONTAINER_MultiHashMap *map,
553 const GNUNET_HashCode * key);
557 * Remove the given key-value pair from the map. Note that if the
558 * key-value pair is in the map multiple times, only one of the pairs
562 * @param key key of the key-value pair
563 * @param value value of the key-value pair
564 * @return GNUNET_YES on success, GNUNET_NO if the key-value pair
567 int GNUNET_CONTAINER_multihashmap_remove (struct GNUNET_CONTAINER_MultiHashMap
568 *map, const GNUNET_HashCode * key,
572 * Remove all entries for the given key from the map.
573 * Note that the values would not be "freed".
576 * @param key identifies values to be removed
577 * @return number of values removed
579 int GNUNET_CONTAINER_multihashmap_remove_all (struct
580 GNUNET_CONTAINER_MultiHashMap
582 const GNUNET_HashCode * key);
586 * Check if the map contains any value under the given
587 * key (including values that are NULL).
590 * @param key the key to test if a value exists for it
591 * @return GNUNET_YES if such a value exists,
594 int GNUNET_CONTAINER_multihashmap_contains (const struct
595 GNUNET_CONTAINER_MultiHashMap
597 const GNUNET_HashCode * key);
601 * Store a key-value pair in the map.
604 * @param key key to use
605 * @param value value to use
606 * @param opt options for put
607 * @return GNUNET_OK on success,
608 * GNUNET_NO if a value was replaced (with REPLACE)
609 * GNUNET_SYSERR if UNIQUE_ONLY was the option and the
610 * value already exists
612 int GNUNET_CONTAINER_multihashmap_put (struct GNUNET_CONTAINER_MultiHashMap
613 *map, const GNUNET_HashCode * key,
616 GNUNET_CONTAINER_MultiHashMapOption
620 * Get the number of key-value pairs in the map.
623 * @return the number of key value pairs
625 unsigned int GNUNET_CONTAINER_multihashmap_size (const struct
626 GNUNET_CONTAINER_MultiHashMap
631 * Iterate over all entries in the map.
634 * @param it function to call on each entry
635 * @param it_cls extra argument to it
636 * @return the number of key value pairs processed,
637 * GNUNET_SYSERR if it aborted iteration
639 int GNUNET_CONTAINER_multihashmap_iterate (const struct
640 GNUNET_CONTAINER_MultiHashMap *map,
641 GNUNET_CONTAINER_HashMapIterator
646 * Iterate over all entries in the map that match a particular key.
649 * @param key key that the entries must correspond to
650 * @param it function to call on each entry
651 * @param it_cls extra argument to it
652 * @return the number of key value pairs processed,
653 * GNUNET_SYSERR if it aborted iteration
655 int GNUNET_CONTAINER_multihashmap_get_multiple (const struct
656 GNUNET_CONTAINER_MultiHashMap
658 const GNUNET_HashCode * key,
659 GNUNET_CONTAINER_HashMapIterator
663 /* ******************** doubly-linked list *************** */
666 * Insert an element at the head of a DLL. Assumes that head, tail and
667 * element are structs with prev and next fields.
669 * @param head pointer to the head of the DLL
670 * @param tail pointer to the tail of the DLL
671 * @param element element to insert
673 #define GNUNET_CONTAINER_DLL_insert(head,tail,element) do { \
674 (element)->next = (head); \
675 (element)->prev = NULL; \
676 if ((tail) == NULL) \
679 (head)->prev = element; \
680 (head) = (element); } while (0)
683 * Insert an element into a DLL after the given other element. Insert
684 * at the head if the other element is NULL.
686 * @param head pointer to the head of the DLL
687 * @param tail pointer to the tail of the DLL
688 * @param other prior element, NULL for insertion at head of DLL
689 * @param element element to insert
691 #define GNUNET_CONTAINER_DLL_insert_after(head,tail,other,element) do { \
692 (element)->prev = (other); \
695 (element)->next = (head); \
696 (head) = (element); \
700 (element)->next = (other)->next; \
701 (other)->next = (element); \
703 if (NULL == (element)->next) \
704 (tail) = (element); \
706 (element)->next->prev = (element); } while (0)
712 * Remove an element from a DLL. Assumes
713 * that head, tail and element are structs
714 * with prev and next fields.
716 * @param head pointer to the head of the DLL
717 * @param tail pointer to the tail of the DLL
718 * @param element element to remove
720 #define GNUNET_CONTAINER_DLL_remove(head,tail,element) do { \
721 if ((element)->prev == NULL) \
722 (head) = (element)->next; \
724 (element)->prev->next = (element)->next; \
725 if ((element)->next == NULL) \
726 (tail) = (element)->prev; \
728 (element)->next->prev = (element)->prev; } while (0)
732 /* ******************** Heap *************** */
736 * Cost by which elements in a heap can be ordered.
738 typedef uint64_t GNUNET_CONTAINER_HeapCostType;
742 * Heap type, either max or min. Hopefully makes the
743 * implementation more useful.
745 enum GNUNET_CONTAINER_HeapOrder
748 * Heap with the maximum cost at the root.
750 GNUNET_CONTAINER_HEAP_ORDER_MAX,
753 * Heap with the minimum cost at the root.
755 GNUNET_CONTAINER_HEAP_ORDER_MIN
762 struct GNUNET_CONTAINER_Heap;
767 * Handle to a node in a heap.
769 struct GNUNET_CONTAINER_HeapNode;
775 * @param order how should the heap be sorted?
776 * @return handle to the heap
778 struct GNUNET_CONTAINER_Heap *
779 GNUNET_CONTAINER_heap_create (enum GNUNET_CONTAINER_HeapOrder order);
783 * Destroys the heap. Only call on a heap that
786 * @param heap heap to destroy
788 void GNUNET_CONTAINER_heap_destroy (struct GNUNET_CONTAINER_Heap *heap);
792 * Get element stored at root of heap.
794 * @param heap heap to inspect
795 * @return NULL if heap is empty
798 GNUNET_CONTAINER_heap_peek (const struct GNUNET_CONTAINER_Heap *heap);
802 * Get the current size of the heap
804 * @param heap the heap to get the size of
805 * @return number of elements stored
808 GNUNET_CONTAINER_heap_get_size (const struct GNUNET_CONTAINER_Heap *heap);
815 * @param node internal node of the heap
816 * @param element value stored at the node
817 * @param cost cost associated with the node
818 * @return GNUNET_YES if we should continue to iterate,
821 typedef int (*GNUNET_CONTAINER_HeapIterator) (void *cls,
822 struct GNUNET_CONTAINER_HeapNode *node,
824 GNUNET_CONTAINER_HeapCostType cost);
828 * Iterate over all entries in the heap.
830 * @param heap the heap
831 * @param iterator function to call on each entry
832 * @param iterator_cls closure for iterator
835 GNUNET_CONTAINER_heap_iterate (const struct GNUNET_CONTAINER_Heap *heap,
836 GNUNET_CONTAINER_HeapIterator iterator,
841 * Return a *uniform* random element from the heap. Choose a random
842 * number between 0 and heap size and then walk directly to it.
843 * This cost can be between 0 and n, amortized cost of logN.
845 * @param heap heap to choose random element from
846 * @param max how many nodes from the heap to choose from
848 * @return data stored at the chosen random node,
849 * NULL if the heap is empty.
853 GNUNET_CONTAINER_heap_get_random (struct GNUNET_CONTAINER_Heap *heap, uint32_t max);
856 * Perform a random walk of the tree. The walk is biased
857 * towards elements closer to the root of the tree (since
858 * each walk starts at the root and ends at a random leaf).
859 * The heap internally tracks the current position of the
862 * @param heap heap to walk
863 * @return data stored at the next random node in the walk;
864 * NULL if the tree is empty.
867 GNUNET_CONTAINER_heap_walk_get_next (struct GNUNET_CONTAINER_Heap *heap);
871 * Inserts a new element into the heap.
873 * @param heap heap to modify
874 * @param element element to insert
875 * @param cost cost for the element
876 * @return node for the new element
878 struct GNUNET_CONTAINER_HeapNode *
879 GNUNET_CONTAINER_heap_insert (struct GNUNET_CONTAINER_Heap *heap,
881 GNUNET_CONTAINER_HeapCostType cost);
885 * Remove root of the heap.
887 * @param heap heap to modify
888 * @return element data stored at the root node
891 GNUNET_CONTAINER_heap_remove_root (struct GNUNET_CONTAINER_Heap *heap);
895 * Removes a node from the heap.
897 * @param heap heap to modify
898 * @param node node to remove
899 * @return element data stored at the node, NULL if heap is empty
902 GNUNET_CONTAINER_heap_remove_node (struct GNUNET_CONTAINER_Heap *heap,
903 struct GNUNET_CONTAINER_HeapNode *node);
907 * Updates the cost of any node in the tree
909 * @param heap heap to modify
910 * @param node node for which the cost is to be changed
911 * @param new_cost new cost for the node
914 GNUNET_CONTAINER_heap_update_cost (struct GNUNET_CONTAINER_Heap *heap,
915 struct GNUNET_CONTAINER_HeapNode *node,
916 GNUNET_CONTAINER_HeapCostType new_cost);
919 /* ******************** Singly linked list *************** */
922 * Possible ways for how data stored in the linked list
923 * might be allocated.
925 enum GNUNET_CONTAINER_SListDisposition
928 * Single-linked list must copy the buffer.
930 GNUNET_CONTAINER_SLIST_DISPOSITION_TRANSIENT = 0,
933 * Data is static, no need to copy or free.
935 GNUNET_CONTAINER_SLIST_DISPOSITION_STATIC = 2,
938 * Data is dynamic, do not copy but free when done.
940 GNUNET_CONTAINER_SLIST_DISPOSITION_DYNAMIC = 4
946 * Handle to a singly linked list
948 struct GNUNET_CONTAINER_SList;
951 * Handle to a singly linked list iterator
953 struct GNUNET_CONTAINER_SList_Iterator;
957 * Add a new element to the list
959 * @param disp memory disposition
960 * @param buf payload buffer
961 * @param len length of the buffer
963 void GNUNET_CONTAINER_slist_add (struct GNUNET_CONTAINER_SList *l,
964 enum GNUNET_CONTAINER_SListDisposition disp,
965 const void *buf, size_t len);
969 * Append a singly linked list to another
970 * @param dst list to append to
974 GNUNET_CONTAINER_slist_append (struct GNUNET_CONTAINER_SList *dst, struct GNUNET_CONTAINER_SList *src);
978 * Create a new singly linked list
979 * @return the new list
981 struct GNUNET_CONTAINER_SList *GNUNET_CONTAINER_slist_create (void);
985 * Destroy a singly linked list
986 * @param l the list to be destroyed
988 void GNUNET_CONTAINER_slist_destroy (struct GNUNET_CONTAINER_SList *l);
992 * Return the beginning of a list
995 * @return iterator pointing to the beginning, free using "GNUNET_free"
997 struct GNUNET_CONTAINER_SList_Iterator *
998 GNUNET_CONTAINER_slist_begin(struct GNUNET_CONTAINER_SList *l);
1006 void GNUNET_CONTAINER_slist_clear (struct GNUNET_CONTAINER_SList *l);
1010 * Check if a list contains a certain element
1012 * @param buf payload buffer to find
1013 * @param len length of the payload (number of bytes in buf)
1015 int GNUNET_CONTAINER_slist_contains (const struct GNUNET_CONTAINER_SList *l, const void *buf, size_t len);
1019 * Count the elements of a list
1021 * @return number of elements in the list
1023 int GNUNET_CONTAINER_slist_count (const struct GNUNET_CONTAINER_SList *l);
1027 * Remove an element from the list
1028 * @param i iterator that points to the element to be removed
1030 void GNUNET_CONTAINER_slist_erase (struct GNUNET_CONTAINER_SList_Iterator *i);
1034 * Insert an element into a list at a specific position
1035 * @param before where to insert the new element
1036 * @param disp memory disposition
1037 * @param buf payload buffer
1038 * @param len length of the payload
1040 void GNUNET_CONTAINER_slist_insert (struct GNUNET_CONTAINER_SList_Iterator *before,
1041 enum GNUNET_CONTAINER_SListDisposition disp,
1047 * Advance an iterator to the next element
1049 * @return GNUNET_YES on success, GNUNET_NO if the end has been reached
1051 int GNUNET_CONTAINER_slist_next (struct GNUNET_CONTAINER_SList_Iterator *i);
1055 * Check if an iterator points beyond the end of a list
1057 * @return GNUNET_YES if the end has been reached, GNUNET_NO if the iterator
1058 * points to a valid element
1060 int GNUNET_CONTAINER_slist_end (struct GNUNET_CONTAINER_SList_Iterator *i);
1064 * Retrieve the element at a specific position in a list
1067 * @param len set to the payload length
1071 GNUNET_CONTAINER_slist_get (const struct GNUNET_CONTAINER_SList_Iterator *i,
1076 * Release an iterator
1079 void GNUNET_CONTAINER_slist_iter_destroy (struct GNUNET_CONTAINER_SList_Iterator *i);
1082 #if 0 /* keep Emacsens' auto-indent happy */
1090 /* ifndef GNUNET_CONTAINER_LIB_H */
1092 /* end of gnunet_container_lib.h */