X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_generate_hash_value.pod;h=a2af1fc4e8af57981f49c40cc98df51023a48dd2;hb=14852ade094615994f43693363e5a4d48dbbb1d3;hp=4136526bf36d741a33072910860d7f41c38341aa;hpb=0010c4a70fc2ffa4a191cf5270442a1fa009bb97;p=m6w6%2Flibmemcached diff --git a/docs/memcached_generate_hash_value.pod b/docs/memcached_generate_hash_value.pod index 4136526b..a2af1fc4 100644 --- a/docs/memcached_generate_hash_value.pod +++ b/docs/memcached_generate_hash_value.pod @@ -1,6 +1,6 @@ =head1 NAME -memcached_generate_hash_value +memcached_generate_hash_value - Hash a key value =head1 LIBRARY @@ -13,18 +13,30 @@ C Client Library for memcached (libmemcached, -lmemcached) uint32_t memcached_generate_hash_value (const char *key, size_t key_length, - memcached_hash hash_algorithm); + memcached_hash_t hash_algorithm); + + uint32_t + memcached_generate_hash (memcached_st *ptr, + const char *key, + size_t key_length); =head1 DESCRIPTION memcached_generate_hash_value() allows you to hash a key using one of -the hash fuctions defined in the library. This method is provided for +the hash functions defined in the library. This method is provided for the convenience of higher-level language bindings and is not necessary for normal memcache operations. The allowed hash algorithm constants are listed in the manpage for memcached_behavior_set(). +memcached_generate_hash() takes a memcached_st struture and produces +the hash value that would have been generated based on the defaults +of the memcached_st structure. + +As of version 0.36 all hash methods have been placed into the library +libhashkit(3) which is linked with libmemcached(3). + =head1 RETURN A 32-bit integer which is the result of hashing the given key. @@ -34,7 +46,7 @@ returned. =head1 HOME To find out more information please check: -L +L =head1 AUTHOR @@ -42,7 +54,7 @@ Brian Aker, Ebrian@tangent.orgE =head1 SEE ALSO -memcached(1) libmemcached(3) memcached_behavior_set(3) +memcached(1) libmemcached(3) memcached_behavior_set(3) libhashkit(3) =cut