/*
- silchashtable.h
+ silchashtable.h
Author: Pekka Riikonen <priikone@silcnet.org>
- Copyright (C) 2001 - 2002 Pekka Riikonen
+ Copyright (C) 2001 - 2003 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
*/
-/****h* silcutil/SilcHashTableAPI
+/****h* silcutil/SILC Hash Table Interface
*
* DESCRIPTION
*
* an extended interface where caller can specify its own hash and comparison
* functions.
*
- * There are two ways tro traverse the entire hash table if this feature
+ * There are two ways to traverse the entire hash table if this feature
* is needed. There exists a foreach function that calls a foreach
* callback for each entry in the hash table. Other way is to use
* SilcHashTableList structure and traverse the hash table inside while()
/****s* silcutil/SilcHashTableAPI/SilcHashTable
*
* NAME
- *
+ *
* typedef struct SilcHashTableStruct *SilcHashTable;
*
* DESCRIPTION
/****s* silcutil/SilcHashTableAPI/SilcHashTableList
*
* NAME
- *
+ *
* typedef struct SilcHashTableListStruct SilcHashTableList;
*
* DESCRIPTION
*
* This structure is used to tarverse the hash table. This structure
- * is given as argument to the silc_hash_table_list function to
+ * is given as argument to the silc_hash_table_list function to
* initialize it and then used to traverse the hash table with the
* silc_hash_table_get function. It needs not be allocated or freed.
*
struct SilcHashTableListStruct {
SilcHashTable ht;
void *entry;
- uint32 index;
- bool auto_rehash;
+ unsigned int index : 31;
+ unsigned int auto_rehash : 1;
};
/***/
*
* SYNOPSIS
*
- * typedef uint32 (*SilcHashFunction)(void *key, void *user_context);
+ * typedef SilcUInt32 (*SilcHashFunction)(void *key, void *user_context);
*
* DESCRIPTION
*
* to the callback.
*
***/
-typedef uint32 (*SilcHashFunction)(void *key, void *user_context);
+typedef SilcUInt32 (*SilcHashFunction)(void *key, void *user_context);
/****f* silcutil/SilcHashTableAPI/SilcHashCompare
*
* SYNOPSIS
*
- * typedef bool (*SilcHashCompare)(void *key1, void *key2,
+ * typedef bool (*SilcHashCompare)(void *key1, void *key2,
* void *user_context);
*
* DESCRIPTION
*
* SYNOPSIS
*
- * typedef void (*SilcHashDestructor)(void *key, void *context,
+ * typedef void (*SilcHashDestructor)(void *key, void *context,
* void *user_context);
*
* DESCRIPTION
*
- * A destructor callback that the library will call to destroy the
- * `key' and `context'. The appliation provides the function when
+ * A destructor callback that the library will call to destroy the
+ * `key' and `context'. The application provides the function when
* allocating a new hash table. The `user_context' is application
* specific context and is delivered to the callback.
*
***/
-typedef void (*SilcHashDestructor)(void *key, void *context,
+typedef void (*SilcHashDestructor)(void *key, void *context,
void *user_context);
/****f* silcutil/SilcHashTableAPI/SilcHashForeach
*
* SYNOPSIS
*
- * typedef void (*SilcHashForeach)(void *key, void *context,
+ * typedef void (*SilcHashForeach)(void *key, void *context,
* void *user_context);
*
* DESCRIPTION
*
* SYNOPSIS
*
- * SilcHashTable silc_hash_table_alloc(uint32 table_size,
+ * SilcHashTable silc_hash_table_alloc(SilcUInt32 table_size,
* SilcHashFunction hash,
* void *hash_user_context,
* SilcHashCompare compare,
* are optional.
*
***/
-SilcHashTable silc_hash_table_alloc(uint32 table_size,
+SilcHashTable silc_hash_table_alloc(SilcUInt32 table_size,
SilcHashFunction hash,
void *hash_user_context,
SilcHashCompare compare,
*
* SYNOPSIS
*
- * uint32 silc_hash_table_size(SilcHashTable ht);
+ * SilcUInt32 silc_hash_table_size(SilcHashTable ht);
*
* DESCRIPTION
*
* hash table.
*
***/
-uint32 silc_hash_table_size(SilcHashTable ht);
+SilcUInt32 silc_hash_table_size(SilcHashTable ht);
/****f* silcutil/SilcHashTableAPI/silc_hash_table_count
*
* SYNOPSIS
*
- * uint32 silc_hash_table_count(SilcHashTable ht);
+ * SilcUInt32 silc_hash_table_count(SilcHashTable ht);
*
* DESCRIPTION
*
* silc_hash_table_rehash is recommended.
*
***/
-uint32 silc_hash_table_count(SilcHashTable ht);
+SilcUInt32 silc_hash_table_count(SilcHashTable ht);
/****f* silcutil/SilcHashTableAPI/silc_hash_table_add
*
*
* SYNOPSIS
*
- * bool silc_hash_table_del_by_context(SilcHashTable ht, void *key,
+ * bool silc_hash_table_del_by_context(SilcHashTable ht, void *key,
* void *context);
*
* DESCRIPTION
* be used to check whether the correct entry is being deleted.
*
***/
-bool silc_hash_table_del_by_context(SilcHashTable ht, void *key,
+bool silc_hash_table_del_by_context(SilcHashTable ht, void *key,
void *context);
/****f* silcutil/SilcHashTableAPI/silc_hash_table_find
* DESCRIPTION
*
* Finds the entry in the hash table by the provided `key' as fast as
- * possible. Return TRUE if the entry was found and FALSE otherwise.
+ * possible. Return TRUE if the entry was found and FALSE otherwise.
* The found entry is returned to the `ret_key' and `ret_context',
* respectively. If the `ret_key and `ret_context' are NULL then this
* maybe used only to check whether given key exists in the table.
bool silc_hash_table_find(SilcHashTable ht, void *key,
void **ret_key, void **ret_context);
+/****f* silcutil/SilcHashTableAPI/silc_hash_table_find_by_context
+ *
+ * SYNOPSIS
+ *
+ * bool silc_hash_table_find_by_context(SilcHashTable ht, void *key,
+ * void *context, void **ret_key);
+ *
+ * DESCRIPTION
+ *
+ * Finds the entry in the hash table by the provided `key' and
+ * `context' as fast as possible. This is handy function when there
+ * can be multiple same keys in the hash table. By using this function
+ * the specific key with specific context can be found. Return
+ * TRUE if the entry with the key and context was found and FALSE
+ * otherwise. The function returns only the key to `ret_key' since
+ * the caller already knows the context.
+ *
+ ***/
+bool silc_hash_table_find_by_context(SilcHashTable ht, void *key,
+ void *context, void **ret_key);
+
/****f* silcutil/SilcHashTableAPI/silc_hash_table_find_foreach
*
* SYNOPSIS
*
* void silc_hash_table_find_foreach(SilcHashTable ht, void *key,
- * SilcHashForeach foreach,
+ * SilcHashForeach foreach,
* void *user_context);
*
* DESCRIPTION
* As the hash table is collision resistant it is possible to save duplicate
* keys to the hash table. This function can be used to find all keys
* and contexts from the hash table that are found using the `key'. The
- * `foreach' is called for every found key.
+ * `foreach' is called for every found key. If no entries can be found
+ * the `foreach' will be called once with the context set NULL and
+ * `key' and `user_context' sent to the function.
*
* NOTES
*
*
* SYNOPSIS
*
- * void silc_hash_table_rehash(SilcHashTable ht, uint32 new_size);
+ * void silc_hash_table_rehash(SilcHashTable ht, SilcUInt32 new_size);
*
* DESCRIPTION
*
* very slow.
*
***/
-void silc_hash_table_rehash(SilcHashTable ht, uint32 new_size);
+void silc_hash_table_rehash(SilcHashTable ht, SilcUInt32 new_size);
/****f* silcutil/SilcHashTableAPI/silc_hash_table_list
*
*
* SYNOPSIS
*
- * bool silc_hash_table_get(SilcHashTableList *htl, void **key,
+ * bool silc_hash_table_get(SilcHashTableList *htl, void **key,
* void **context);
*
* DESCRIPTION
* SYNOPSIS
*
* void silc_hash_table_add_ext(SilcHashTable ht, void *key, void *context,
- * SilcHashFunction hash,
+ * SilcHashFunction hash,
* void *hash_user_context);
*
* DESCRIPTION
*
* SYNOPSIS
*
- * void silc_hash_table_replace_ext(SilcHashTable ht, void *key,
+ * void silc_hash_table_replace_ext(SilcHashTable ht, void *key,
* void *context,
- * SilcHashFunction hash,
+ * SilcHashFunction hash,
* void *hash_user_context);
*
* DESCRIPTION
*
***/
void silc_hash_table_replace_ext(SilcHashTable ht, void *key, void *context,
- SilcHashFunction hash,
+ SilcHashFunction hash,
void *hash_user_context);
/****f* silcutil/SilcHashTableAPI/silc_hash_table_del_ext
* SYNOPSIS
*
* bool silc_hash_table_del_ext(SilcHashTable ht, void *key,
- * SilcHashFunction hash,
+ * SilcHashFunction hash,
* void *hash_user_context,
- * SilcHashCompare compare,
+ * SilcHashCompare compare,
* void *compare_user_context,
* SilcHashDestructor destructor,
* void *destructor_user_context);
*
***/
bool silc_hash_table_del_ext(SilcHashTable ht, void *key,
- SilcHashFunction hash,
+ SilcHashFunction hash,
void *hash_user_context,
- SilcHashCompare compare,
+ SilcHashCompare compare,
void *compare_user_context,
SilcHashDestructor destructor,
void *destructor_user_context);
*
* SYNOPSIS
*
- * bool silc_hash_table_del_by_context_ext(SilcHashTable ht, void *key,
+ * bool silc_hash_table_del_by_context_ext(SilcHashTable ht, void *key,
* void *context,
- * SilcHashFunction hash,
+ * SilcHashFunction hash,
* void *hash_user_context,
- * SilcHashCompare compare,
+ * SilcHashCompare compare,
* void *compare_user_context,
* SilcHashDestructor destructor,
* void *destructor_user_context);
* specific destructor function.
*
***/
-bool silc_hash_table_del_by_context_ext(SilcHashTable ht, void *key,
+bool silc_hash_table_del_by_context_ext(SilcHashTable ht, void *key,
void *context,
- SilcHashFunction hash,
+ SilcHashFunction hash,
void *hash_user_context,
- SilcHashCompare compare,
+ SilcHashCompare compare,
void *compare_user_context,
SilcHashDestructor destructor,
void *destructor_user_context);
*
* bool silc_hash_table_find_ext(SilcHashTable ht, void *key,
* void **ret_key, void **ret_context,
- * SilcHashFunction hash,
+ * SilcHashFunction hash,
* void *hash_user_context,
- * SilcHashCompare compare,
+ * SilcHashCompare compare,
* void *compare_user_context);
*
* DESCRIPTION
*
* Finds the entry in the hash table by the provided `key' as fast as
- * possible. Return TRUE if the entry was found and FALSE otherwise.
+ * possible. Return TRUE if the entry was found and FALSE otherwise.
* The found entry is returned to the `ret_key' and `ret_context',
* respectively. If the `ret_key and `ret_context' are NULL then this
* maybe used only to check whether given key exists in the table.
***/
bool silc_hash_table_find_ext(SilcHashTable ht, void *key,
void **ret_key, void **ret_context,
- SilcHashFunction hash,
+ SilcHashFunction hash,
void *hash_user_context,
- SilcHashCompare compare,
+ SilcHashCompare compare,
void *compare_user_context);
+/****f* silcutil/SilcHashTableAPI/silc_hash_table_find_by_context_ext
+ *
+ * SYNOPSIS
+ *
+ * bool silc_hash_table_find_by_context_ext(SilcHashTable ht, void *key,
+ * void *context, void **ret_key,
+ * SilcHashFunction hash,
+ * void *hash_user_context,
+ * SilcHashCompare compare,
+ * void *compare_user_context);
+ *
+ * DESCRIPTION
+ *
+ * Finds the entry in the hash table by the provided `key' and
+ * `context' as fast as possible. This is handy function when there
+ * can be multiple same keys in the hash table. By using this function
+ * the specific key with specific context can be found. Return
+ * TRUE if the entry with the key and context was found and FALSE
+ * otherwise. The function returns only the key to `ret_key' since
+ * the caller already knows the context.
+ *
+ * The `hash' and `hash_user_context' are application specified hash
+ * function. If not provided the hash table's default is used.
+ * The `compare' and `compare_user_context' are application specified
+ * comparing function. If not provided the hash table's default is used.
+ *
+ ***/
+bool silc_hash_table_find_by_context_ext(SilcHashTable ht, void *key,
+ void *context, void **ret_key,
+ SilcHashFunction hash,
+ void *hash_user_context,
+ SilcHashCompare compare,
+ void *compare_user_context);
+
/****f* silcutil/SilcHashTableAPI/silc_hash_table_find_foreach_ext
*
* SYNOPSIS
*
* void silc_hash_table_find_foreach_ext(SilcHashTable ht, void *key,
- * SilcHashFunction hash,
+ * SilcHashFunction hash,
* void *hash_user_context,
- * SilcHashCompare compare,
+ * SilcHashCompare compare,
* void *compare_user_context,
- * SilcHashForeach foreach,
+ * SilcHashForeach foreach,
* void *foreach_user_context);
*
* DESCRIPTION
* As the hash table is collision resistant it is possible to save duplicate
* keys to the hash table. This function can be used to find all keys
* and contexts from the hash table that are found using the `key'. The
- * `foreach' is called for every found key.
+ * `foreach' is called for every found key. If no entries can be found
+ * the `foreach' will be called once with the context set NULL and
+ * `key' and `user_context' sent to the function.
*
* The `hash' and `hash_user_context' are application specified hash
* function. If not provided the hash table's default is used.
*
***/
void silc_hash_table_find_foreach_ext(SilcHashTable ht, void *key,
- SilcHashFunction hash,
+ SilcHashFunction hash,
void *hash_user_context,
- SilcHashCompare compare,
+ SilcHashCompare compare,
void *compare_user_context,
- SilcHashForeach foreach,
+ SilcHashForeach foreach,
void *foreach_user_context);
/****f* silcutil/SilcHashTableAPI/silc_hash_table_rehash_ext
*
* SYNOPSIS
*
- * void silc_hash_table_rehash_ext(SilcHashTable ht, uint32 new_size,
- * SilcHashFunction hash,
+ * void silc_hash_table_rehash_ext(SilcHashTable ht, SilcUInt32 new_size,
+ * SilcHashFunction hash,
* void *hash_user_context);
*
* DESCRIPTION
* function. If not provided the hash table's default is used.
*
***/
-void silc_hash_table_rehash_ext(SilcHashTable ht, uint32 new_size,
- SilcHashFunction hash,
+void silc_hash_table_rehash_ext(SilcHashTable ht, SilcUInt32 new_size,
+ SilcHashFunction hash,
void *hash_user_context);
#endif
projects / silc.git / blobdiff