X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fhashkit_value.rst;h=d27e35281ee74814941bd34f22ed469a5a98b986;hb=3302041bbe7bda096d658e7032e77763ed6187f5;hp=ec5d71b6d0b0ea780745567e5280bd07e4821601;hpb=f0a568f40ab283bb0be08bd0d930c70386418b97;p=awesomized%2Flibmemcached diff --git a/docs/hashkit_value.rst b/docs/hashkit_value.rst index ec5d71b6..d27e3528 100644 --- a/docs/hashkit_value.rst +++ b/docs/hashkit_value.rst @@ -1,77 +1,55 @@ -.. highlight:: perl - - +============= hashkit_value -************* - - -Generate a value for the given key - +============= -******* -LIBRARY -******* +.. index:: object: hashkit_st -C Library for hashing algorithms (libhashkit, -lhashkit) - +Generate a value for the given key -******** +-------- SYNOPSIS -******** +-------- +#include -.. code-block:: perl - - #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)`