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 * Resize a bloom filter. Note that this operation
176 * is pretty costly. Essentially, the bloom filter
177 * needs to be completely re-build.
179 * @param bf the filter
180 * @param iterator an iterator over all elements stored in the BF
181 * @param iterator_cls closure for iterator
182 * @param size the new size for the filter
183 * @param k the new number of GNUNET_CRYPTO_hash-function to apply per element
185 void GNUNET_CONTAINER_bloomfilter_resize (struct GNUNET_CONTAINER_BloomFilter
187 GNUNET_HashCodeIterator iterator,
189 size_t size, unsigned int k);
191 /* ****************** metadata ******************* */
194 * Meta data to associate with a file, directory or namespace.
196 struct GNUNET_CONTAINER_MetaData;
199 * Create a fresh MetaData token.
201 * @return empty meta-data container
203 struct GNUNET_CONTAINER_MetaData *
204 GNUNET_CONTAINER_meta_data_create (void);
207 * Duplicate a MetaData token.
209 * @param md what to duplicate
210 * @return duplicate meta-data container
212 struct GNUNET_CONTAINER_MetaData *
213 GNUNET_CONTAINER_meta_data_duplicate (const struct
214 GNUNET_CONTAINER_MetaData *md);
219 * @param md what to free
222 GNUNET_CONTAINER_meta_data_destroy (struct GNUNET_CONTAINER_MetaData *md);
225 * Test if two MDs are equal. We consider them equal if
226 * the meta types, formats and content match (we do not
227 * include the mime types and plugins names in this
230 * @param md1 first value to check
231 * @param md2 other value to check
232 * @return GNUNET_YES if they are equal
235 GNUNET_CONTAINER_meta_data_test_equal (const struct
236 GNUNET_CONTAINER_MetaData *md1,
238 GNUNET_CONTAINER_MetaData *md2);
244 * @param md metadata to extend
245 * @param plugin_name name of the plugin that produced this value;
246 * special values can be used (i.e. '<zlib>' for zlib being
247 * used in the main libextractor library and yielding
249 * @param type libextractor-type describing the meta data
250 * @param format basic format information about data
251 * @param data_mime_type mime-type of data (not of the original file);
252 * can be NULL (if mime-type is not known)
253 * @param data actual meta-data found
254 * @param data_len number of bytes in data
255 * @return GNUNET_OK on success, GNUNET_SYSERR if this entry already exists
256 * data_mime_type and plugin_name are not considered for "exists" checks
259 GNUNET_CONTAINER_meta_data_insert (struct GNUNET_CONTAINER_MetaData *md,
260 const char *plugin_name,
261 enum EXTRACTOR_MetaType type,
262 enum EXTRACTOR_MetaFormat format,
263 const char *data_mime_type,
269 * Extend metadata. Merges the meta data from the second argument
270 * into the first, discarding duplicate key-value pairs.
272 * @param md metadata to extend
273 * @param in metadata to merge
276 GNUNET_CONTAINER_meta_data_merge (struct GNUNET_CONTAINER_MetaData *md,
277 const struct GNUNET_CONTAINER_MetaData *in);
283 * @param md metadata to manipulate
284 * @param type type of the item to remove
285 * @param data specific value to remove, NULL to remove all
286 * entries of the given type
287 * @param data_len number of bytes in data
288 * @return GNUNET_OK on success, GNUNET_SYSERR if the item does not exist in md
291 GNUNET_CONTAINER_meta_data_delete (struct GNUNET_CONTAINER_MetaData *md,
292 enum EXTRACTOR_MetaType type,
298 * Remove all items in the container.
300 * @param md metadata to manipulate
303 GNUNET_CONTAINER_meta_data_clear (struct GNUNET_CONTAINER_MetaData *md);
307 * Add the current time as the publication date
310 * @param md metadata to modify
313 GNUNET_CONTAINER_meta_data_add_publication_date (struct
314 GNUNET_CONTAINER_MetaData
319 * Iterate over MD entries.
321 * @param md metadata to inspect
322 * @param iter function to call on each entry
323 * @param iter_cls closure for iterator
324 * @return number of entries
326 int GNUNET_CONTAINER_meta_data_iterate (const struct
327 GNUNET_CONTAINER_MetaData *md,
328 EXTRACTOR_MetaDataProcessor
329 iter, void *iter_cls);
332 * Get the first MD entry of the given type. Caller
333 * is responsible for freeing the return value.
334 * Also, only meta data items that are strings (0-terminated)
335 * are returned by this function.
337 * @param md metadata to inspect
338 * @param type type to look for
339 * @return NULL if no entry was found
342 GNUNET_CONTAINER_meta_data_get_by_type (const struct
343 GNUNET_CONTAINER_MetaData *md,
344 enum EXTRACTOR_MetaType type);
348 * Get the first matching MD entry of the given types. Caller is
349 * responsible for freeing the return value. Also, only meta data
350 * items that are strings (0-terminated) are returned by this
353 * @param md metadata to inspect
354 * @param ... -1-terminated list of types
355 * @return NULL if we do not have any such entry,
356 * otherwise client is responsible for freeing the value!
359 GNUNET_CONTAINER_meta_data_get_first_by_types (const struct
360 GNUNET_CONTAINER_MetaData
364 * Get a thumbnail from the meta-data (if present). Only matches meta
365 * data with mime type "image" and binary format.
367 * @param md metadata to inspect
368 * @param thumb will be set to the thumbnail data. Must be
369 * freed by the caller!
370 * @return number of bytes in thumbnail, 0 if not available
373 GNUNET_CONTAINER_meta_data_get_thumbnail (const struct
374 GNUNET_CONTAINER_MetaData
375 *md, unsigned char **thumb);
380 * Options for metadata serialization.
382 enum GNUNET_CONTAINER_MetaDataSerializationOptions
385 * Serialize all of the data.
387 GNUNET_CONTAINER_META_DATA_SERIALIZE_FULL = 0,
390 * If not enough space is available, it is acceptable
391 * to only serialize some of the metadata.
393 GNUNET_CONTAINER_META_DATA_SERIALIZE_PART = 1,
396 * Speed is of the essence, do not allow compression.
398 GNUNET_CONTAINER_META_DATA_SERIALIZE_NO_COMPRESS = 2
403 * Serialize meta-data to target.
405 * @param md metadata to serialize
406 * @param target where to write the serialized metadata;
407 * *target can be NULL, in which case memory is allocated
408 * @param max maximum number of bytes available
409 * @param opt is it ok to just write SOME of the
410 * meta-data to match the size constraint,
411 * possibly discarding some data?
412 * @return number of bytes written on success,
413 * -1 on error (typically: not enough
416 ssize_t GNUNET_CONTAINER_meta_data_serialize (const struct
417 GNUNET_CONTAINER_MetaData *md,
421 GNUNET_CONTAINER_MetaDataSerializationOptions
426 * Get the size of the full meta-data in serialized form.
428 * @param md metadata to inspect
429 * @return number of bytes needed for serialization, -1 on error
431 ssize_t GNUNET_CONTAINER_meta_data_get_serialized_size (const struct
432 GNUNET_CONTAINER_MetaData
437 * Deserialize meta-data. Initializes md.
439 * @param input serialized meta-data.
440 * @param size number of bytes available
441 * @return MD on success, NULL on error (i.e.
444 struct GNUNET_CONTAINER_MetaData
445 *GNUNET_CONTAINER_meta_data_deserialize (const char *input,
449 /* ******************************* HashMap **************************** */
452 * Opaque handle for a HashMap.
454 struct GNUNET_CONTAINER_MultiHashMap;
457 * Options for storing values in the HashMap.
459 enum GNUNET_CONTAINER_MultiHashMapOption
463 * If a value with the given key exists, replace it. Note that the
464 * old value would NOT be freed by replace (the application has to
465 * make sure that this happens if required).
467 GNUNET_CONTAINER_MULTIHASHMAPOPTION_REPLACE,
470 * Allow multiple values with the same key.
472 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE,
475 * There must only be one value per key; storing a value should fail
476 * if a value under the same key already exists.
478 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY,
481 * There must only be one value per key, but don't bother checking
482 * if a value already exists (faster than UNIQUE_ONLY; implemented
483 * just like MULTIPLE but this option documents better what is
484 * intended if UNIQUE is what is desired).
486 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST
491 * Iterator over hash map entries.
494 * @param key current key code
495 * @param value value in the hash map
496 * @return GNUNET_YES if we should continue to
500 typedef int (*GNUNET_CONTAINER_HashMapIterator) (void *cls,
501 const GNUNET_HashCode * key,
506 * Create a multi hash map.
508 * @param len initial size (map will grow as needed)
509 * @return NULL on error
511 struct GNUNET_CONTAINER_MultiHashMap
512 *GNUNET_CONTAINER_multihashmap_create (unsigned int len);
516 * Destroy a hash map. Will not free any values
517 * stored in the hash map!
521 void GNUNET_CONTAINER_multihashmap_destroy (struct
522 GNUNET_CONTAINER_MultiHashMap
527 * Given a key find a value in the map matching the key.
530 * @param key what to look for
531 * @return NULL if no value was found; note that
532 * this is indistinguishable from values that just
533 * happen to be NULL; use "contains" to test for
534 * key-value pairs with value NULL
536 void *GNUNET_CONTAINER_multihashmap_get (const struct
537 GNUNET_CONTAINER_MultiHashMap *map,
538 const GNUNET_HashCode * key);
542 * Remove the given key-value pair from the map. Note that if the
543 * key-value pair is in the map multiple times, only one of the pairs
547 * @param key key of the key-value pair
548 * @param value value of the key-value pair
549 * @return GNUNET_YES on success, GNUNET_NO if the key-value pair
552 int GNUNET_CONTAINER_multihashmap_remove (struct GNUNET_CONTAINER_MultiHashMap
553 *map, const GNUNET_HashCode * key,
557 * Remove all entries for the given key from the map.
558 * Note that the values would not be "freed".
561 * @param key identifies values to be removed
562 * @return number of values removed
564 int GNUNET_CONTAINER_multihashmap_remove_all (struct
565 GNUNET_CONTAINER_MultiHashMap
567 const GNUNET_HashCode * key);
571 * Check if the map contains any value under the given
572 * key (including values that are NULL).
575 * @param key the key to test if a value exists for it
576 * @return GNUNET_YES if such a value exists,
579 int GNUNET_CONTAINER_multihashmap_contains (const struct
580 GNUNET_CONTAINER_MultiHashMap
582 const GNUNET_HashCode * key);
586 * Store a key-value pair in the map.
589 * @param key key to use
590 * @param value value to use
591 * @param opt options for put
592 * @return GNUNET_OK on success,
593 * GNUNET_NO if a value was replaced (with REPLACE)
594 * GNUNET_SYSERR if UNIQUE_ONLY was the option and the
595 * value already exists
597 int GNUNET_CONTAINER_multihashmap_put (struct GNUNET_CONTAINER_MultiHashMap
598 *map, const GNUNET_HashCode * key,
601 GNUNET_CONTAINER_MultiHashMapOption
605 * Get the number of key-value pairs in the map.
608 * @return the number of key value pairs
610 unsigned int GNUNET_CONTAINER_multihashmap_size (const struct
611 GNUNET_CONTAINER_MultiHashMap
616 * Iterate over all entries in the map.
619 * @param it function to call on each entry
620 * @param it_cls extra argument to it
621 * @return the number of key value pairs processed,
622 * GNUNET_SYSERR if it aborted iteration
624 int GNUNET_CONTAINER_multihashmap_iterate (const struct
625 GNUNET_CONTAINER_MultiHashMap *map,
626 GNUNET_CONTAINER_HashMapIterator
631 * Iterate over all entries in the map that match a particular key.
634 * @param key key that the entries must correspond to
635 * @param it function to call on each entry
636 * @param it_cls extra argument to it
637 * @return the number of key value pairs processed,
638 * GNUNET_SYSERR if it aborted iteration
640 int GNUNET_CONTAINER_multihashmap_get_multiple (const struct
641 GNUNET_CONTAINER_MultiHashMap
643 const GNUNET_HashCode * key,
644 GNUNET_CONTAINER_HashMapIterator
648 /* ******************** doubly-linked list *************** */
651 * Insert an element at the head of a DLL. Assumes that head, tail and
652 * element are structs with prev and next fields.
654 * @param head pointer to the head of the DLL
655 * @param tail pointer to the tail of the DLL
656 * @param element element to insert
658 #define GNUNET_CONTAINER_DLL_insert(head,tail,element) do { \
659 (element)->next = (head); \
660 (element)->prev = NULL; \
661 if ((tail) == NULL) \
664 (head)->prev = element; \
665 (head) = (element); } while (0)
668 * Insert an element into a DLL after the given other element. Insert
669 * at the head if the other element is NULL.
671 * @param head pointer to the head of the DLL
672 * @param tail pointer to the tail of the DLL
673 * @param other prior element, NULL for insertion at head of DLL
674 * @param element element to insert
676 #define GNUNET_CONTAINER_DLL_insert_after(head,tail,other,element) do { \
677 (element)->prev = (other); \
680 (element)->next = (head); \
681 (head) = (element); \
685 (element)->next = (other)->next; \
686 (other)->next = (element); \
688 if (NULL == (element)->next) \
689 (tail) = (element); \
691 (element)->next->prev = (element); } while (0)
697 * Remove an element from a DLL. Assumes
698 * that head, tail and element are structs
699 * with prev and next fields.
701 * @param head pointer to the head of the DLL
702 * @param tail pointer to the tail of the DLL
703 * @param element element to remove
705 #define GNUNET_CONTAINER_DLL_remove(head,tail,element) do { \
706 if ((element)->prev == NULL) \
707 (head) = (element)->next; \
709 (element)->prev->next = (element)->next; \
710 if ((element)->next == NULL) \
711 (tail) = (element)->prev; \
713 (element)->next->prev = (element)->prev; } while (0)
717 /* ******************** Heap *************** */
721 * Cost by which elements in a heap can be ordered.
723 typedef uint64_t GNUNET_CONTAINER_HeapCostType;
727 * Heap type, either max or min. Hopefully makes the
728 * implementation more useful.
730 enum GNUNET_CONTAINER_HeapOrder
733 * Heap with the maximum cost at the root.
735 GNUNET_CONTAINER_HEAP_ORDER_MAX,
738 * Heap with the minimum cost at the root.
740 GNUNET_CONTAINER_HEAP_ORDER_MIN
747 struct GNUNET_CONTAINER_Heap;
752 * Handle to a node in a heap.
754 struct GNUNET_CONTAINER_HeapNode;
760 * @param order how should the heap be sorted?
761 * @return handle to the heap
763 struct GNUNET_CONTAINER_Heap *
764 GNUNET_CONTAINER_heap_create (enum GNUNET_CONTAINER_HeapOrder order);
768 * Destroys the heap. Only call on a heap that
771 * @param heap heap to destroy
773 void GNUNET_CONTAINER_heap_destroy (struct GNUNET_CONTAINER_Heap *heap);
777 * Get element stored at root of heap.
779 * @param heap heap to inspect
780 * @return NULL if heap is empty
783 GNUNET_CONTAINER_heap_peek (const struct GNUNET_CONTAINER_Heap *heap);
787 * Get the current size of the heap
789 * @param heap the heap to get the size of
790 * @return number of elements stored
793 GNUNET_CONTAINER_heap_get_size (const struct GNUNET_CONTAINER_Heap *heap);
800 * @param node internal node of the heap
801 * @param element value stored at the node
802 * @param cost cost associated with the node
803 * @return GNUNET_YES if we should continue to iterate,
806 typedef int (*GNUNET_CONTAINER_HeapIterator) (void *cls,
807 struct GNUNET_CONTAINER_HeapNode *node,
809 GNUNET_CONTAINER_HeapCostType cost);
813 * Iterate over all entries in the heap.
815 * @param heap the heap
816 * @param iterator function to call on each entry
817 * @param iterator_cls closure for iterator
820 GNUNET_CONTAINER_heap_iterate (const struct GNUNET_CONTAINER_Heap *heap,
821 GNUNET_CONTAINER_HeapIterator iterator,
826 * Return a *uniform* random element from the heap. Choose a random
827 * number between 0 and heap size and then walk directly to it.
828 * This cost can be between 0 and n, amortized cost of logN.
830 * @param heap heap to choose random element from
831 * @param max how many nodes from the heap to choose from
833 * @return data stored at the chosen random node,
834 * NULL if the heap is empty.
838 GNUNET_CONTAINER_heap_get_random (struct GNUNET_CONTAINER_Heap *heap, uint32_t max);
841 * Perform a random walk of the tree. The walk is biased
842 * towards elements closer to the root of the tree (since
843 * each walk starts at the root and ends at a random leaf).
844 * The heap internally tracks the current position of the
847 * @param heap heap to walk
848 * @return data stored at the next random node in the walk;
849 * NULL if the tree is empty.
852 GNUNET_CONTAINER_heap_walk_get_next (struct GNUNET_CONTAINER_Heap *heap);
856 * Inserts a new element into the heap.
858 * @param heap heap to modify
859 * @param element element to insert
860 * @param cost cost for the element
861 * @return node for the new element
863 struct GNUNET_CONTAINER_HeapNode *
864 GNUNET_CONTAINER_heap_insert (struct GNUNET_CONTAINER_Heap *heap,
866 GNUNET_CONTAINER_HeapCostType cost);
870 * Remove root of the heap.
872 * @param heap heap to modify
873 * @return element data stored at the root node
876 GNUNET_CONTAINER_heap_remove_root (struct GNUNET_CONTAINER_Heap *heap);
880 * Removes a node from the heap.
882 * @param heap heap to modify
883 * @param node node to remove
884 * @return element data stored at the node, NULL if heap is empty
887 GNUNET_CONTAINER_heap_remove_node (struct GNUNET_CONTAINER_Heap *heap,
888 struct GNUNET_CONTAINER_HeapNode *node);
892 * Updates the cost of any node in the tree
894 * @param heap heap to modify
895 * @param node node for which the cost is to be changed
896 * @param new_cost new cost for the node
899 GNUNET_CONTAINER_heap_update_cost (struct GNUNET_CONTAINER_Heap *heap,
900 struct GNUNET_CONTAINER_HeapNode *node,
901 GNUNET_CONTAINER_HeapCostType new_cost);
904 /* ******************** Singly linked list *************** */
907 * Possible ways for how data stored in the linked list
908 * might be allocated.
910 enum GNUNET_CONTAINER_SListDisposition
913 * Single-linked list must copy the buffer.
915 GNUNET_CONTAINER_SLIST_DISPOSITION_TRANSIENT = 0,
918 * Data is static, no need to copy or free.
920 GNUNET_CONTAINER_SLIST_DISPOSITION_STATIC = 2,
923 * Data is dynamic, do not copy but free when done.
925 GNUNET_CONTAINER_SLIST_DISPOSITION_DYNAMIC = 4
931 * Handle to a singly linked list
933 struct GNUNET_CONTAINER_SList;
936 * Handle to a singly linked list iterator
938 struct GNUNET_CONTAINER_SList_Iterator;
942 * Add a new element to the list
944 * @param disp memory disposition
945 * @param buf payload buffer
946 * @param len length of the buffer
948 void GNUNET_CONTAINER_slist_add (struct GNUNET_CONTAINER_SList *l,
949 enum GNUNET_CONTAINER_SListDisposition disp,
950 const void *buf, size_t len);
954 * Append a singly linked list to another
955 * @param dst list to append to
959 GNUNET_CONTAINER_slist_append (struct GNUNET_CONTAINER_SList *dst, struct GNUNET_CONTAINER_SList *src);
963 * Create a new singly linked list
964 * @return the new list
966 struct GNUNET_CONTAINER_SList *GNUNET_CONTAINER_slist_create (void);
970 * Destroy a singly linked list
971 * @param l the list to be destroyed
973 void GNUNET_CONTAINER_slist_destroy (struct GNUNET_CONTAINER_SList *l);
977 * Return the beginning of a list
980 * @return iterator pointing to the beginning, free using "GNUNET_free"
982 struct GNUNET_CONTAINER_SList_Iterator *
983 GNUNET_CONTAINER_slist_begin(struct GNUNET_CONTAINER_SList *l);
991 void GNUNET_CONTAINER_slist_clear (struct GNUNET_CONTAINER_SList *l);
995 * Check if a list contains a certain element
997 * @param buf payload buffer to find
998 * @param len length of the payload (number of bytes in buf)
1000 int GNUNET_CONTAINER_slist_contains (const struct GNUNET_CONTAINER_SList *l, const void *buf, size_t len);
1004 * Count the elements of a list
1006 * @return number of elements in the list
1008 int GNUNET_CONTAINER_slist_count (const struct GNUNET_CONTAINER_SList *l);
1012 * Remove an element from the list
1013 * @param i iterator that points to the element to be removed
1015 void GNUNET_CONTAINER_slist_erase (struct GNUNET_CONTAINER_SList_Iterator *i);
1019 * Insert an element into a list at a specific position
1020 * @param before where to insert the new element
1021 * @param disp memory disposition
1022 * @param buf payload buffer
1023 * @param len length of the payload
1025 void GNUNET_CONTAINER_slist_insert (struct GNUNET_CONTAINER_SList_Iterator *before,
1026 enum GNUNET_CONTAINER_SListDisposition disp,
1032 * Advance an iterator to the next element
1034 * @return GNUNET_YES on success, GNUNET_NO if the end has been reached
1036 int GNUNET_CONTAINER_slist_next (struct GNUNET_CONTAINER_SList_Iterator *i);
1040 * Check if an iterator points beyond the end of a list
1042 * @return GNUNET_YES if the end has been reached, GNUNET_NO if the iterator
1043 * points to a valid element
1045 int GNUNET_CONTAINER_slist_end (struct GNUNET_CONTAINER_SList_Iterator *i);
1049 * Retrieve the element at a specific position in a list
1052 * @param len set to the payload length
1056 GNUNET_CONTAINER_slist_get (const struct GNUNET_CONTAINER_SList_Iterator *i,
1061 * Release an iterator
1064 void GNUNET_CONTAINER_slist_iter_destroy (struct GNUNET_CONTAINER_SList_Iterator *i);
1067 #if 0 /* keep Emacsens' auto-indent happy */
1075 /* ifndef GNUNET_CONTAINER_LIB_H */
1077 /* end of gnunet_container_lib.h */