X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_generate_hash_value.rst;h=b6f401e4c38bac2d4ec77b256e14ee0f07cc4da0;hb=088eed04d829b8cf6591201564118c356d3cf935;hp=6eb7cf17bdbf1f244da185dd865da788d2d43f66;hpb=bf12e933c3c73aa04d8de2221144cc73cc9ef3b8;p=m6w6%2Flibmemcached diff --git a/docs/memcached_generate_hash_value.rst b/docs/memcached_generate_hash_value.rst index 6eb7cf17..b6f401e4 100644 --- a/docs/memcached_generate_hash_value.rst +++ b/docs/memcached_generate_hash_value.rst @@ -1,46 +1,28 @@ -.. highlight:: perl - - -memcached_generate_hash_value -***************************** +=============================== +Generating hash values directly +=============================== Hash a key value -******* -LIBRARY -******* - - -C Client Library for memcached (libmemcached, -lmemcached) - +-------- +SYNOPSIS +-------- -******** -SYNOPSIS -******** - - -.. code-block:: perl - - #include +#include - uint32_t - memcached_generate_hash_value (const char *key, - size_t key_length, - memcached_hash_t hash_algorithm); - - uint32_t - memcached_generate_hash (memcached_st *ptr, - const char *key, - size_t key_length); +.. c:function:: uint32_t memcached_generate_hash_value (const char *key, size_t key_length, memcached_hash_t hash_algorithm); + +.. c:function:: uint32_t memcached_generate_hash (memcached_st *ptr, const char *key, size_t key_length); +Compile and link with -lmemcachedutil -lmemcached -*********** +----------- DESCRIPTION -*********** +----------- memcached_generate_hash_value() allows you to hash a key using one of @@ -56,12 +38,12 @@ 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). +libhashkit(3) which is linked with libmemcached(3). For more information please see its documentation. -****** +------ RETURN -****** +------ A 32-bit integer which is the result of hashing the given key. @@ -69,26 +51,26 @@ For 64-bit hash algorithms, only the least-significant 32 bits are returned. -**** +---- HOME -**** +---- To find out more information please check: -`https://launchpad.net/libmemcached `_ +`http://libmemcached.org/ `_ -****** +------ AUTHOR -****** +------ Brian Aker, -******** +-------- SEE ALSO -******** +-------- :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`