X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fhashkit_functions.rst;h=542fd95f6021a93a27cbc4e9d5127b95fcaabef9;hb=8b33bb5adbffec6e701728c085e4606a2f7cd506;hp=883f6e1d49df961e716db21226f56e79ec12ab50;hpb=49fc1e5ea4ea006f4a2ac71428833760f6fac030;p=m6w6%2Flibmemcached diff --git a/docs/hashkit_functions.rst b/docs/hashkit_functions.rst index 883f6e1d..542fd95f 100644 --- a/docs/hashkit_functions.rst +++ b/docs/hashkit_functions.rst @@ -1,34 +1,28 @@ -.. highlight:: perl +================ +Available Hashes +================ -**** -NAME -**** +Various hash functions to use for calculating values for keys -hashkit_default, hashkit_fnv1_64, hashkit_fnv1a_64, hashkit_fnv1_32, -hashkit_fnv1a_32, hashkit_crc32, hashkit_hsieh, hashkit_murmur, -hashkit_jenkins, hashkit_md5 - Various hash functions to use for -calculating values for keys - - -******* +------- LIBRARY -******* +------- -C Library for hashing algorithms (libhashkit, -lhashkit) +C Library for hashing algorithms (libmemcached, -lhashkit) -******** +-------- SYNOPSIS -******** +-------- .. code-block:: perl - #include + #include uint32_t hashkit_default(const char *key, size_t key_length); uint32_t hashkit_fnv1_64(const char *key, size_t key_length); @@ -43,9 +37,9 @@ SYNOPSIS -*********** +----------- DESCRIPTION -*********** +----------- These functions generate hash values from a key using a variety of @@ -56,34 +50,26 @@ The hashkit_hsieh() is only available if the library is built with the appropriate flag enabled. -************ +------------ RETURN VALUE -************ +------------ A 32-bit hash value. -**** +---- HOME -**** +---- To find out more information please check: `https://launchpad.net/libmemcached `_ -****** -AUTHOR -****** - - -Brian Aker, - - -******** +-------- SEE ALSO -******** +-------- hashkit_create(3) hashkit_value(3) hashkit_set_hash_fn(3)