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 (const 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 (const 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
155 * Get size of the bloom filter.
157 * @param bf the filter
158 * @return number of bytes used for the data of the bloom filter
161 GNUNET_CONTAINER_bloomfilter_get_size (const struct GNUNET_CONTAINER_BloomFilter
166 * Reset a bloom filter to empty.
167 * @param bf the filter
169 void GNUNET_CONTAINER_bloomfilter_clear (struct GNUNET_CONTAINER_BloomFilter
173 * Or the entries of the given raw data array with the
174 * data of the given bloom filter. Assumes that
175 * the size of the data array and the current filter
178 * @param bf the filter
179 * @param data data to OR-in
180 * @param size size of data
181 * @return GNUNET_OK on success
183 int GNUNET_CONTAINER_bloomfilter_or (struct GNUNET_CONTAINER_BloomFilter *bf,
184 const char *data, size_t size);
187 * Or the entries of the given raw data array with the
188 * data of the given bloom filter. Assumes that
189 * the size of the data array and the current filter
192 * @param bf the filter
193 * @param to_or the bloomfilter to or-in
194 * @param size number of bytes in data
197 GNUNET_CONTAINER_bloomfilter_or2 (struct GNUNET_CONTAINER_BloomFilter *bf,
198 const struct GNUNET_CONTAINER_BloomFilter *to_or,
202 * Resize a bloom filter. Note that this operation
203 * is pretty costly. Essentially, the bloom filter
204 * needs to be completely re-build.
206 * @param bf the filter
207 * @param iterator an iterator over all elements stored in the BF
208 * @param iterator_cls closure for iterator
209 * @param size the new size for the filter
210 * @param k the new number of GNUNET_CRYPTO_hash-function to apply per element
212 void GNUNET_CONTAINER_bloomfilter_resize (struct GNUNET_CONTAINER_BloomFilter
214 GNUNET_HashCodeIterator iterator,
216 size_t size, unsigned int k);
218 /* ****************** metadata ******************* */
221 * Meta data to associate with a file, directory or namespace.
223 struct GNUNET_CONTAINER_MetaData;
226 * Create a fresh MetaData token.
228 * @return empty meta-data container
230 struct GNUNET_CONTAINER_MetaData *
231 GNUNET_CONTAINER_meta_data_create (void);
234 * Duplicate a MetaData token.
236 * @param md what to duplicate
237 * @return duplicate meta-data container
239 struct GNUNET_CONTAINER_MetaData *
240 GNUNET_CONTAINER_meta_data_duplicate (const struct
241 GNUNET_CONTAINER_MetaData *md);
246 * @param md what to free
249 GNUNET_CONTAINER_meta_data_destroy (struct GNUNET_CONTAINER_MetaData *md);
252 * Test if two MDs are equal. We consider them equal if
253 * the meta types, formats and content match (we do not
254 * include the mime types and plugins names in this
257 * @param md1 first value to check
258 * @param md2 other value to check
259 * @return GNUNET_YES if they are equal
262 GNUNET_CONTAINER_meta_data_test_equal (const struct
263 GNUNET_CONTAINER_MetaData *md1,
265 GNUNET_CONTAINER_MetaData *md2);
271 * @param md metadata to extend
272 * @param plugin_name name of the plugin that produced this value;
273 * special values can be used (i.e. '<zlib>' for zlib being
274 * used in the main libextractor library and yielding
276 * @param type libextractor-type describing the meta data
277 * @param format basic format information about data
278 * @param data_mime_type mime-type of data (not of the original file);
279 * can be NULL (if mime-type is not known)
280 * @param data actual meta-data found
281 * @param data_len number of bytes in data
282 * @return GNUNET_OK on success, GNUNET_SYSERR if this entry already exists
283 * data_mime_type and plugin_name are not considered for "exists" checks
286 GNUNET_CONTAINER_meta_data_insert (struct GNUNET_CONTAINER_MetaData *md,
287 const char *plugin_name,
288 enum EXTRACTOR_MetaType type,
289 enum EXTRACTOR_MetaFormat format,
290 const char *data_mime_type,
296 * Extend metadata. Merges the meta data from the second argument
297 * into the first, discarding duplicate key-value pairs.
299 * @param md metadata to extend
300 * @param in metadata to merge
303 GNUNET_CONTAINER_meta_data_merge (struct GNUNET_CONTAINER_MetaData *md,
304 const struct GNUNET_CONTAINER_MetaData *in);
310 * @param md metadata to manipulate
311 * @param type type of the item to remove
312 * @param data specific value to remove, NULL to remove all
313 * entries of the given type
314 * @param data_len number of bytes in data
315 * @return GNUNET_OK on success, GNUNET_SYSERR if the item does not exist in md
318 GNUNET_CONTAINER_meta_data_delete (struct GNUNET_CONTAINER_MetaData *md,
319 enum EXTRACTOR_MetaType type,
325 * Remove all items in the container.
327 * @param md metadata to manipulate
330 GNUNET_CONTAINER_meta_data_clear (struct GNUNET_CONTAINER_MetaData *md);
334 * Add the current time as the publication date
337 * @param md metadata to modify
340 GNUNET_CONTAINER_meta_data_add_publication_date (struct
341 GNUNET_CONTAINER_MetaData
346 * Iterate over MD entries.
348 * @param md metadata to inspect
349 * @param iter function to call on each entry
350 * @param iter_cls closure for iterator
351 * @return number of entries
353 int GNUNET_CONTAINER_meta_data_iterate (const struct
354 GNUNET_CONTAINER_MetaData *md,
355 EXTRACTOR_MetaDataProcessor
356 iter, void *iter_cls);
359 * Get the first MD entry of the given type. Caller
360 * is responsible for freeing the return value.
361 * Also, only meta data items that are strings (0-terminated)
362 * are returned by this function.
364 * @param md metadata to inspect
365 * @param type type to look for
366 * @return NULL if no entry was found
369 GNUNET_CONTAINER_meta_data_get_by_type (const struct
370 GNUNET_CONTAINER_MetaData *md,
371 enum EXTRACTOR_MetaType type);
375 * Get the first matching MD entry of the given types. Caller is
376 * responsible for freeing the return value. Also, only meta data
377 * items that are strings (0-terminated) are returned by this
380 * @param md metadata to inspect
381 * @param ... -1-terminated list of types
382 * @return NULL if we do not have any such entry,
383 * otherwise client is responsible for freeing the value!
386 GNUNET_CONTAINER_meta_data_get_first_by_types (const struct
387 GNUNET_CONTAINER_MetaData
391 * Get a thumbnail from the meta-data (if present). Only matches meta
392 * data with mime type "image" and binary format.
394 * @param md metadata to inspect
395 * @param thumb will be set to the thumbnail data. Must be
396 * freed by the caller!
397 * @return number of bytes in thumbnail, 0 if not available
400 GNUNET_CONTAINER_meta_data_get_thumbnail (const struct
401 GNUNET_CONTAINER_MetaData
402 *md, unsigned char **thumb);
407 * Options for metadata serialization.
409 enum GNUNET_CONTAINER_MetaDataSerializationOptions
412 * Serialize all of the data.
414 GNUNET_CONTAINER_META_DATA_SERIALIZE_FULL = 0,
417 * If not enough space is available, it is acceptable
418 * to only serialize some of the metadata.
420 GNUNET_CONTAINER_META_DATA_SERIALIZE_PART = 1,
423 * Speed is of the essence, do not allow compression.
425 GNUNET_CONTAINER_META_DATA_SERIALIZE_NO_COMPRESS = 2
430 * Serialize meta-data to target.
432 * @param md metadata to serialize
433 * @param target where to write the serialized metadata;
434 * *target can be NULL, in which case memory is allocated
435 * @param max maximum number of bytes available
436 * @param opt is it ok to just write SOME of the
437 * meta-data to match the size constraint,
438 * possibly discarding some data?
439 * @return number of bytes written on success,
440 * -1 on error (typically: not enough
443 ssize_t GNUNET_CONTAINER_meta_data_serialize (const struct
444 GNUNET_CONTAINER_MetaData *md,
448 GNUNET_CONTAINER_MetaDataSerializationOptions
453 * Get the size of the full meta-data in serialized form.
455 * @param md metadata to inspect
456 * @return number of bytes needed for serialization, -1 on error
458 ssize_t GNUNET_CONTAINER_meta_data_get_serialized_size (const struct
459 GNUNET_CONTAINER_MetaData
464 * Deserialize meta-data. Initializes md.
466 * @param input serialized meta-data.
467 * @param size number of bytes available
468 * @return MD on success, NULL on error (i.e.
471 struct GNUNET_CONTAINER_MetaData
472 *GNUNET_CONTAINER_meta_data_deserialize (const char *input,
476 /* ******************************* HashMap **************************** */
479 * Opaque handle for a HashMap.
481 struct GNUNET_CONTAINER_MultiHashMap;
484 * Options for storing values in the HashMap.
486 enum GNUNET_CONTAINER_MultiHashMapOption
490 * If a value with the given key exists, replace it. Note that the
491 * old value would NOT be freed by replace (the application has to
492 * make sure that this happens if required).
494 GNUNET_CONTAINER_MULTIHASHMAPOPTION_REPLACE,
497 * Allow multiple values with the same key.
499 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE,
502 * There must only be one value per key; storing a value should fail
503 * if a value under the same key already exists.
505 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY,
508 * There must only be one value per key, but don't bother checking
509 * if a value already exists (faster than UNIQUE_ONLY; implemented
510 * just like MULTIPLE but this option documents better what is
511 * intended if UNIQUE is what is desired).
513 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST
518 * Iterator over hash map entries.
521 * @param key current key code
522 * @param value value in the hash map
523 * @return GNUNET_YES if we should continue to
527 typedef int (*GNUNET_CONTAINER_HashMapIterator) (void *cls,
528 const GNUNET_HashCode * key,
533 * Create a multi hash map.
535 * @param len initial size (map will grow as needed)
536 * @return NULL on error
538 struct GNUNET_CONTAINER_MultiHashMap
539 *GNUNET_CONTAINER_multihashmap_create (unsigned int len);
543 * Destroy a hash map. Will not free any values
544 * stored in the hash map!
548 void GNUNET_CONTAINER_multihashmap_destroy (struct
549 GNUNET_CONTAINER_MultiHashMap
554 * Given a key find a value in the map matching the key.
557 * @param key what to look for
558 * @return NULL if no value was found; note that
559 * this is indistinguishable from values that just
560 * happen to be NULL; use "contains" to test for
561 * key-value pairs with value NULL
563 void *GNUNET_CONTAINER_multihashmap_get (const struct
564 GNUNET_CONTAINER_MultiHashMap *map,
565 const GNUNET_HashCode * key);
569 * Remove the given key-value pair from the map. Note that if the
570 * key-value pair is in the map multiple times, only one of the pairs
574 * @param key key of the key-value pair
575 * @param value value of the key-value pair
576 * @return GNUNET_YES on success, GNUNET_NO if the key-value pair
579 int GNUNET_CONTAINER_multihashmap_remove (struct GNUNET_CONTAINER_MultiHashMap
580 *map, const GNUNET_HashCode * key,
584 * Remove all entries for the given key from the map.
585 * Note that the values would not be "freed".
588 * @param key identifies values to be removed
589 * @return number of values removed
591 int GNUNET_CONTAINER_multihashmap_remove_all (struct
592 GNUNET_CONTAINER_MultiHashMap
594 const GNUNET_HashCode * key);
598 * Check if the map contains any value under the given
599 * key (including values that are NULL).
602 * @param key the key to test if a value exists for it
603 * @return GNUNET_YES if such a value exists,
606 int GNUNET_CONTAINER_multihashmap_contains (const struct
607 GNUNET_CONTAINER_MultiHashMap
609 const GNUNET_HashCode * key);
613 * Store a key-value pair in the map.
616 * @param key key to use
617 * @param value value to use
618 * @param opt options for put
619 * @return GNUNET_OK on success,
620 * GNUNET_NO if a value was replaced (with REPLACE)
621 * GNUNET_SYSERR if UNIQUE_ONLY was the option and the
622 * value already exists
624 int GNUNET_CONTAINER_multihashmap_put (struct GNUNET_CONTAINER_MultiHashMap
625 *map, const GNUNET_HashCode * key,
628 GNUNET_CONTAINER_MultiHashMapOption
632 * Get the number of key-value pairs in the map.
635 * @return the number of key value pairs
637 unsigned int GNUNET_CONTAINER_multihashmap_size (const struct
638 GNUNET_CONTAINER_MultiHashMap
643 * Iterate over all entries in the map.
646 * @param it function to call on each entry
647 * @param it_cls extra argument to it
648 * @return the number of key value pairs processed,
649 * GNUNET_SYSERR if it aborted iteration
651 int GNUNET_CONTAINER_multihashmap_iterate (const struct
652 GNUNET_CONTAINER_MultiHashMap *map,
653 GNUNET_CONTAINER_HashMapIterator
658 * Iterate over all entries in the map that match a particular key.
661 * @param key key that the entries must correspond to
662 * @param it function to call on each entry
663 * @param it_cls extra argument to it
664 * @return the number of key value pairs processed,
665 * GNUNET_SYSERR if it aborted iteration
667 int GNUNET_CONTAINER_multihashmap_get_multiple (const struct
668 GNUNET_CONTAINER_MultiHashMap
670 const GNUNET_HashCode * key,
671 GNUNET_CONTAINER_HashMapIterator
675 /* ******************** doubly-linked list *************** */
678 * Insert an element at the head of a DLL. Assumes that head, tail and
679 * element are structs with prev and next fields.
681 * @param head pointer to the head of the DLL
682 * @param tail pointer to the tail of the DLL
683 * @param element element to insert
685 #define GNUNET_CONTAINER_DLL_insert(head,tail,element) do { \
686 (element)->next = (head); \
687 (element)->prev = NULL; \
688 if ((tail) == NULL) \
691 (head)->prev = element; \
692 (head) = (element); } while (0)
695 * Insert an element into a DLL after the given other element. Insert
696 * at the head if the other element is NULL.
698 * @param head pointer to the head of the DLL
699 * @param tail pointer to the tail of the DLL
700 * @param other prior element, NULL for insertion at head of DLL
701 * @param element element to insert
703 #define GNUNET_CONTAINER_DLL_insert_after(head,tail,other,element) do { \
704 (element)->prev = (other); \
707 (element)->next = (head); \
708 (head) = (element); \
712 (element)->next = (other)->next; \
713 (other)->next = (element); \
715 if (NULL == (element)->next) \
716 (tail) = (element); \
718 (element)->next->prev = (element); } while (0)
724 * Remove an element from a DLL. Assumes
725 * that head, tail and element are structs
726 * with prev and next fields.
728 * @param head pointer to the head of the DLL
729 * @param tail pointer to the tail of the DLL
730 * @param element element to remove
732 #define GNUNET_CONTAINER_DLL_remove(head,tail,element) do { \
733 if ((element)->prev == NULL) \
734 (head) = (element)->next; \
736 (element)->prev->next = (element)->next; \
737 if ((element)->next == NULL) \
738 (tail) = (element)->prev; \
740 (element)->next->prev = (element)->prev; } while (0)
744 /* ******************** Heap *************** */
748 * Cost by which elements in a heap can be ordered.
750 typedef uint64_t GNUNET_CONTAINER_HeapCostType;
754 * Heap type, either max or min. Hopefully makes the
755 * implementation more useful.
757 enum GNUNET_CONTAINER_HeapOrder
760 * Heap with the maximum cost at the root.
762 GNUNET_CONTAINER_HEAP_ORDER_MAX,
765 * Heap with the minimum cost at the root.
767 GNUNET_CONTAINER_HEAP_ORDER_MIN
774 struct GNUNET_CONTAINER_Heap;
779 * Handle to a node in a heap.
781 struct GNUNET_CONTAINER_HeapNode;
787 * @param order how should the heap be sorted?
788 * @return handle to the heap
790 struct GNUNET_CONTAINER_Heap *
791 GNUNET_CONTAINER_heap_create (enum GNUNET_CONTAINER_HeapOrder order);
795 * Destroys the heap. Only call on a heap that
798 * @param heap heap to destroy
800 void GNUNET_CONTAINER_heap_destroy (struct GNUNET_CONTAINER_Heap *heap);
804 * Get element stored at root of heap.
806 * @param heap heap to inspect
807 * @return NULL if heap is empty
810 GNUNET_CONTAINER_heap_peek (const struct GNUNET_CONTAINER_Heap *heap);
814 * Get the current size of the heap
816 * @param heap the heap to get the size of
817 * @return number of elements stored
820 GNUNET_CONTAINER_heap_get_size (const struct GNUNET_CONTAINER_Heap *heap);
827 * @param node internal node of the heap
828 * @param element value stored at the node
829 * @param cost cost associated with the node
830 * @return GNUNET_YES if we should continue to iterate,
833 typedef int (*GNUNET_CONTAINER_HeapIterator) (void *cls,
834 struct GNUNET_CONTAINER_HeapNode *node,
836 GNUNET_CONTAINER_HeapCostType cost);
840 * Iterate over all entries in the heap.
842 * @param heap the heap
843 * @param iterator function to call on each entry
844 * @param iterator_cls closure for iterator
847 GNUNET_CONTAINER_heap_iterate (const struct GNUNET_CONTAINER_Heap *heap,
848 GNUNET_CONTAINER_HeapIterator iterator,
853 * Return a *uniform* random element from the heap. Choose a random
854 * number between 0 and heap size and then walk directly to it.
855 * This cost can be between 0 and n, amortized cost of logN.
857 * @param heap heap to choose random element from
858 * @param max how many nodes from the heap to choose from
860 * @return data stored at the chosen random node,
861 * NULL if the heap is empty.
865 GNUNET_CONTAINER_heap_get_random (struct GNUNET_CONTAINER_Heap *heap, uint32_t max);
868 * Perform a random walk of the tree. The walk is biased
869 * towards elements closer to the root of the tree (since
870 * each walk starts at the root and ends at a random leaf).
871 * The heap internally tracks the current position of the
874 * @param heap heap to walk
875 * @return data stored at the next random node in the walk;
876 * NULL if the tree is empty.
879 GNUNET_CONTAINER_heap_walk_get_next (struct GNUNET_CONTAINER_Heap *heap);
883 * Inserts a new element into the heap.
885 * @param heap heap to modify
886 * @param element element to insert
887 * @param cost cost for the element
888 * @return node for the new element
890 struct GNUNET_CONTAINER_HeapNode *
891 GNUNET_CONTAINER_heap_insert (struct GNUNET_CONTAINER_Heap *heap,
893 GNUNET_CONTAINER_HeapCostType cost);
897 * Remove root of the heap.
899 * @param heap heap to modify
900 * @return element data stored at the root node
903 GNUNET_CONTAINER_heap_remove_root (struct GNUNET_CONTAINER_Heap *heap);
907 * Removes a node from the heap.
909 * @param heap heap to modify
910 * @param node node to remove
911 * @return element data stored at the node, NULL if heap is empty
914 GNUNET_CONTAINER_heap_remove_node (struct GNUNET_CONTAINER_Heap *heap,
915 struct GNUNET_CONTAINER_HeapNode *node);
919 * Updates the cost of any node in the tree
921 * @param heap heap to modify
922 * @param node node for which the cost is to be changed
923 * @param new_cost new cost for the node
926 GNUNET_CONTAINER_heap_update_cost (struct GNUNET_CONTAINER_Heap *heap,
927 struct GNUNET_CONTAINER_HeapNode *node,
928 GNUNET_CONTAINER_HeapCostType new_cost);
931 /* ******************** Singly linked list *************** */
934 * Possible ways for how data stored in the linked list
935 * might be allocated.
937 enum GNUNET_CONTAINER_SListDisposition
940 * Single-linked list must copy the buffer.
942 GNUNET_CONTAINER_SLIST_DISPOSITION_TRANSIENT = 0,
945 * Data is static, no need to copy or free.
947 GNUNET_CONTAINER_SLIST_DISPOSITION_STATIC = 2,
950 * Data is dynamic, do not copy but free when done.
952 GNUNET_CONTAINER_SLIST_DISPOSITION_DYNAMIC = 4
958 * Handle to a singly linked list
960 struct GNUNET_CONTAINER_SList;
963 * Handle to a singly linked list iterator
965 struct GNUNET_CONTAINER_SList_Iterator;
969 * Add a new element to the list
971 * @param disp memory disposition
972 * @param buf payload buffer
973 * @param len length of the buffer
975 void GNUNET_CONTAINER_slist_add (struct GNUNET_CONTAINER_SList *l,
976 enum GNUNET_CONTAINER_SListDisposition disp,
977 const void *buf, size_t len);
981 * Add a new element to the end of the list
983 * @param disp memory disposition
984 * @param buf payload buffer
985 * @param len length of the buffer
987 void GNUNET_CONTAINER_slist_add_end (struct GNUNET_CONTAINER_SList *l,
988 enum GNUNET_CONTAINER_SListDisposition disp,
989 const void *buf, size_t len);
993 * Append a singly linked list to another
994 * @param dst list to append to
998 GNUNET_CONTAINER_slist_append (struct GNUNET_CONTAINER_SList *dst, struct GNUNET_CONTAINER_SList *src);
1002 * Create a new singly linked list
1003 * @return the new list
1005 struct GNUNET_CONTAINER_SList *GNUNET_CONTAINER_slist_create (void);
1009 * Destroy a singly linked list
1010 * @param l the list to be destroyed
1012 void GNUNET_CONTAINER_slist_destroy (struct GNUNET_CONTAINER_SList *l);
1016 * Return the beginning of a list
1019 * @return iterator pointing to the beginning, free using "GNUNET_free"
1021 struct GNUNET_CONTAINER_SList_Iterator *
1022 GNUNET_CONTAINER_slist_begin(struct GNUNET_CONTAINER_SList *l);
1030 void GNUNET_CONTAINER_slist_clear (struct GNUNET_CONTAINER_SList *l);
1034 * Check if a list contains a certain element
1036 * @param buf payload buffer to find
1037 * @param len length of the payload (number of bytes in buf)
1039 int GNUNET_CONTAINER_slist_contains (const struct GNUNET_CONTAINER_SList *l, const void *buf, size_t len);
1043 * Count the elements of a list
1045 * @return number of elements in the list
1047 int GNUNET_CONTAINER_slist_count (const struct GNUNET_CONTAINER_SList *l);
1051 * Remove an element from the list
1052 * @param i iterator that points to the element to be removed
1054 void GNUNET_CONTAINER_slist_erase (struct GNUNET_CONTAINER_SList_Iterator *i);
1058 * Insert an element into a list at a specific position
1059 * @param before where to insert the new element
1060 * @param disp memory disposition
1061 * @param buf payload buffer
1062 * @param len length of the payload
1064 void GNUNET_CONTAINER_slist_insert (struct GNUNET_CONTAINER_SList_Iterator *before,
1065 enum GNUNET_CONTAINER_SListDisposition disp,
1071 * Advance an iterator to the next element
1073 * @return GNUNET_YES on success, GNUNET_NO if the end has been reached
1075 int GNUNET_CONTAINER_slist_next (struct GNUNET_CONTAINER_SList_Iterator *i);
1079 * Check if an iterator points beyond the end of a list
1081 * @return GNUNET_YES if the end has been reached, GNUNET_NO if the iterator
1082 * points to a valid element
1084 int GNUNET_CONTAINER_slist_end (struct GNUNET_CONTAINER_SList_Iterator *i);
1088 * Retrieve the element at a specific position in a list
1091 * @param len set to the payload length
1095 GNUNET_CONTAINER_slist_get (const struct GNUNET_CONTAINER_SList_Iterator *i,
1100 * Release an iterator
1103 void GNUNET_CONTAINER_slist_iter_destroy (struct GNUNET_CONTAINER_SList_Iterator *i);
1106 #if 0 /* keep Emacsens' auto-indent happy */
1114 /* ifndef GNUNET_CONTAINER_LIB_H */
1116 /* end of gnunet_container_lib.h */