X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fhashkit_value.rst;h=d27e35281ee74814941bd34f22ed469a5a98b986;hb=458694809f0633be65695c2e845e2333652e4b91;hp=5c34b157a02027f5892c9355a8959492f2fe7325;hpb=49fc1e5ea4ea006f4a2ac71428833760f6fac030;p=awesomized%2Flibmemcached diff --git a/docs/hashkit_value.rst b/docs/hashkit_value.rst index 5c34b157..d27e3528 100644 --- a/docs/hashkit_value.rst +++ b/docs/hashkit_value.rst @@ -1,78 +1,55 @@ -.. highlight:: perl +============= +hashkit_value +============= -**** -NAME -**** +.. index:: object: hashkit_st +Generate a value for the given key -hashkit_value - Generate a value for the given key - - -******* -LIBRARY -******* - - -C Library for hashing algorithms (libhashkit, -lhashkit) - - -******** +-------- SYNOPSIS -******** - +-------- -.. code-block:: perl +#include - #include +.. c:function:: uint32_t hashkit_value(hashkit_st *hash, const char *key, size_t key_length) - uint32_t hashkit_value(hashkit_st *hash, - const char *key, - size_t key_length); +Compile and link with -lhashkit - - -*********** +----------- DESCRIPTION -*********** +----------- -The hashkit_value() function generates a 32-bit hash value from the +The :c:func:`hashkit_value` function generates a 32-bit hash value from the given key and key_length. The hash argument is an initialized hashkit object, and distribution type and hash function is used from this object while generating the value. -************ +------------ RETURN VALUE -************ +------------ A 32-bit hash value. -**** +---- HOME -**** +---- To find out more information please check: -`https://launchpad.net/libmemcached `_ - - -****** -AUTHOR -****** - - -Brian Aker, +`http://libmemcached.org/ `_ -******** +-------- SEE ALSO -******** +-------- -hashkit_create(3) hashkit_set_distribution(3) hashkit_set_hash_fn(3) +:manpage:`hashkit_create(3)` :manpage:`hashkit_set_distribution(3)` :manpage:`hashkit_set_hash_fn(3)`