X-Git-Url: http://git.silcnet.org/gitweb/?a=blobdiff_plain;f=lib%2Fsilcutil%2Fsilclist.h;h=66efd22fa7dd8667df1280a8ccff30a06e0464bc;hb=30b8fb532138b2d9b523d3c069724e78fb72f8e3;hp=1cd197700eea7cf9076fcab1855d0bbdfda55c25;hpb=40f8443d8d3a6577336ee66d18e04d9ac4d956bb;p=silc.git

diff --git a/lib/silcutil/silclist.h b/lib/silcutil/silclist.h
index 1cd19770..66efd22f 100644
--- a/lib/silcutil/silclist.h
+++ b/lib/silcutil/silclist.h
@@ -4,7 +4,7 @@
 
   Author: Pekka Riikonen <priikone@silcnet.org>
 
-  Copyright (C) 2002 - 2005 Pekka Riikonen
+  Copyright (C) 2002 - 2007 Pekka Riikonen
 
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
@@ -21,8 +21,24 @@
  *
  * DESCRIPTION
  *
- * Implementation of the SilcList interface.  This interface provides
- * simple linked list.
+ * Generic list interface that can turn any structure with list pointers
+ * into a SilcList.  The interface can provide both singly and doubly linked
+ * lists.  The interface does not allocate any memory.
+ *
+ * SILC List is not thread-safe.  If the same list context must be used
+ * in multithreaded environment concurrency control must be employed.
+ *
+ * EXAMPLE
+ *
+ * struct EntryStruct {
+ *   char *dummy;
+ *   struct EntryStruct *next;        // The list member pointer
+ * };
+ *
+ * SilcList list;
+ *
+ * // Initialize list
+ * silc_list_init(list, struct EntryStruct, next);
  *
  ***/
 
@@ -41,7 +57,7 @@
  *    function silc_list_init.
  *
  ***/
-typedef struct {
+typedef struct SilcListStruct {
   void *head;			     /* Start of the list */
   void *tail;			     /* End of the list */
   void *current;		     /* Current pointer in list */
@@ -101,6 +117,7 @@ do {							\
   (list).next_offset = silc_offsetof(type, nextfield);	\
   (list).prev_set = 0;					\
   (list).prev_offset = 0;				\
+  (list).end_set = 0;					\
   (list).head = (list).tail = (list).current = NULL;	\
 } while(0)
 
@@ -140,6 +157,7 @@ do {								\
   (list).next_offset = silc_offsetof(type, nextfield);		\
   (list).prev_offset = silc_offsetof(type, prevfield);		\
   (list).prev_set = 1;						\
+  (list).end_set = 0;						\
   (list).head = (list).tail = (list).current = NULL;		\
 } while(0)