diff options
author | Simo Sorce <ssorce@redhat.com> | 2009-12-08 14:12:03 -0500 |
---|---|---|
committer | Stephen Gallagher <sgallagh@redhat.com> | 2009-12-08 23:35:30 -0500 |
commit | 3076876258e79cf0db6e800a799b042b3ac5bea6 (patch) | |
tree | 732833a9ead93d89c5169b6af26977b58affccc0 /dhash | |
parent | 4a5e256201c886d09a8dadd3f299baadde506a2f (diff) | |
download | ding-libs-3076876258e79cf0db6e800a799b042b3ac5bea6.tar.gz ding-libs-3076876258e79cf0db6e800a799b042b3ac5bea6.tar.xz ding-libs-3076876258e79cf0db6e800a799b042b3ac5bea6.zip |
Add comments to document latest changes
Diffstat (limited to 'dhash')
-rw-r--r-- | dhash/dhash.h | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/dhash/dhash.h b/dhash/dhash.h index 72b054e..47f9673 100644 --- a/dhash/dhash.h +++ b/dhash/dhash.h @@ -177,6 +177,9 @@ const char* hash_error_string(int error); * parameter is a pointer to a function which will be called just prior to a * hash entry being deleted. This is useful when the hash value has items which * may need to be disposed of. The delete_callback may be NULL. + * The delete_private_data is data passed to the delete_callback, this way + * custom callbacks can have a private context to reach data they need to use + * before performning their operations. delete_private_data may be NULL. */ int hash_create(unsigned long count, hash_table_t **tbl, hash_delete_callback *delete_callback, @@ -194,6 +197,10 @@ int hash_create(unsigned long count, hash_table_t **tbl, * is greater than the max_load_factor the table is expanded. * alloc_func: function pointer for allocation * free_func: funciton pointer for freeing memory allocated with alloc_func + * alloc_private data: data passed to the alloc and free functions so that + * custom functions can refernce other private data they may + * need during their execution without having to use global + * variables. * * Note directory_bits + segment_bits must be <= number of bits in unsigned long */ |