updates. New data types.

[silc.git] / lib / silccore / idcache.h

diff --git a/lib/silccore/idcache.h b/lib/silccore/idcache.h
index 582019ceff79d3405458b68ddd73c75c3a4c4404..80b60f004b3b2649474722a6ad5185a4af519da4 100644 (file)
--- a/lib/silccore/idcache.h
+++ b/lib/silccore/idcache.h
@@ -29,7 +29,8 @@
    filled with ID cache utility functions. The ID cache system does not
    allocate any of these fields nor free them.
 
-   char *data
+   unsigned char *data
+   uint32 data_len;
 
       The data that is usually used to find the data from the cache.
       For example for Client ID's this is nickname.
@@ -42,12 +43,12 @@
 
       The actual ID.
 
-   unsigned long expire
+   uint32 expire
 
       Time when this cache entry expires.  This is normal time() value
       plus the validity.  Cache entry has expired if current time is
-      more than value in this field, or if this field has been set to
-      zero (0) value.
+      more than value in this field.  If this value is zero (0) the
+      entry never expires.
 
    void *context
 
@@ -55,10 +56,11 @@
 
 */
 typedef struct {
-  char *data;
+  unsigned char *data;
+  uint32 data_len;
   SilcIdType type;
   void *id;
-  unsigned long expire;
+  uint32 expire;
   void *context;
 } *SilcIDCacheEntry;
 
@@ -68,19 +70,28 @@ typedef struct SilcIDCacheStruct *SilcIDCache;
 /* Forward declaration for ID Cache List */
 typedef struct SilcIDCacheListStruct *SilcIDCacheList;
 
+/* Destructor callback that is called when an cache entry expires or is
+   purged from the ID cache. The application must not free cache entry
+   because the library will do it automatically. The appliation, however,
+   is responsible of freeing any data in the entry. */
+typedef void (*SilcIDCacheDestructor)(SilcIDCache cache,
+                                     SilcIDCacheEntry entry);
+
 #define SILC_ID_CACHE_ANY ((void *)1)
 
 #define SILC_ID_CACHE_EXPIRE 3600
+#define SILC_ID_CACHE_EXPIRE_DEF (time(NULL) + SILC_ID_CACHE_EXPIRE)
 
 /* Prototypes */
-SilcIDCache silc_idcache_alloc(unsigned int count);
+SilcIDCache silc_idcache_alloc(uint32 count,
+                              SilcIDCacheDestructor destructor);
 void silc_idcache_free(SilcIDCache cache);
 void silc_idcache_sort_by_data(SilcIDCache cache);
-int silc_idcache_find_by_data(SilcIDCache cache, char *data, 
+int silc_idcache_find_by_data(SilcIDCache cache, unsigned char *data, 
                              SilcIDCacheList *ret);
-int silc_idcache_find_by_data_one(SilcIDCache cache, char *data,
+int silc_idcache_find_by_data_one(SilcIDCache cache, unsigned char *data,
                                  SilcIDCacheEntry *ret);
-int silc_idcache_find_by_data_loose(SilcIDCache cache, char *data, 
+int silc_idcache_find_by_data_loose(SilcIDCache cache, unsigned char *data, 
                                    SilcIDCacheList *ret);
 int silc_idcache_find_by_id(SilcIDCache cache, void *id, SilcIdType type,
                            SilcIDCacheList *ret);
@@ -88,13 +99,15 @@ int silc_idcache_find_by_id_one(SilcIDCache cache, void *id, SilcIdType type,
                                SilcIDCacheEntry *ret);
 int silc_idcache_find_by_context(SilcIDCache cache, void *context, 
                                 SilcIDCacheEntry *ret);
-int silc_idcache_add(SilcIDCache cache, char *data, SilcIdType id_type,
-                    void *id, void *context, int sort);
+int silc_idcache_add(SilcIDCache cache, unsigned char *data, 
+                    uint32 data_len, SilcIdType id_type, void *id, 
+                    void *context, int sort, int expire);
 int silc_idcache_del(SilcIDCache cache, SilcIDCacheEntry old);
-int silc_idcache_del_by_data(SilcIDCache cache, char *data);
+int silc_idcache_del_by_data(SilcIDCache cache, unsigned char *data);
 int silc_idcache_del_by_id(SilcIDCache cache, SilcIdType type, void *id);
 int silc_idcache_del_all(SilcIDCache cache);
 int silc_idcache_purge(SilcIDCache cache);
+int silc_idcache_purge_by_context(SilcIDCache cache, void *context);
 int silc_idcache_list_count(SilcIDCacheList list);
 int silc_idcache_list_first(SilcIDCacheList list, SilcIDCacheEntry *ret);
 int silc_idcache_list_next(SilcIDCacheList list, SilcIDCacheEntry *ret);