diff options
| author | Continuous Integration <ci@tangent.org> | 2014-02-16 03:31:37 -0800 |
|---|---|---|
| committer | Continuous Integration <ci@tangent.org> | 2014-02-16 03:31:37 -0800 |
| commit | b163cbc1e82ea834b66e3b4c1e8070394ccb506d (patch) | |
| tree | 999734df2e2c288d6726af31f9336beadb2a781a /docs/source/hashkit_functions.rst | |
| parent | 8541a9863cffad457f4d583af6a6c3613250193d (diff) | |
| parent | 37deb7fa75a0b3fbea4d58c032446213f0d5a02a (diff) | |
| download | libmemcached-trunk.tar.gz | |
Diffstat (limited to 'docs/source/hashkit_functions.rst')
| -rw-r--r-- | docs/source/hashkit_functions.rst | 75 |
1 files changed, 75 insertions, 0 deletions
diff --git a/docs/source/hashkit_functions.rst b/docs/source/hashkit_functions.rst new file mode 100644 index 00000000..4db41661 --- /dev/null +++ b/docs/source/hashkit_functions.rst @@ -0,0 +1,75 @@ +================ +Available Hashes +================ + +.. index:: object: hashkit_st + +Various hash functions to use for calculating values for keys + + +-------- +SYNOPSIS +-------- + +#include <libhashkit/hashkit.h> + +.. c:function:: uint32_t hashkit_default(const char *key, size_t key_length) + +.. c:function:: uint32_t hashkit_fnv1_64(const char *key, size_t key_length) + +.. c:function:: uint32_t hashkit_fnv1a_64(const char *key, size_t key_length) + +.. c:function:: uint32_t hashkit_fnv1_32(const char *key, size_t key_length) + +.. c:function:: uint32_t hashkit_fnv1a_32(const char *key, size_t key_length) + +.. c:function:: uint32_t hashkit_crc32(const char *key, size_t key_length) + +.. c:function:: uint32_t hashkit_hsieh(const char *key, size_t key_length) + +.. c:function:: uint32_t hashkit_murmur(const char *key, size_t key_length) + +.. c:function:: uint32_t hashkit_jenkins(const char *key, size_t key_length) + +.. c:function:: uint32_t hashkit_md5(const char *key, size_t key_length) + +Compile and link with -lhashkit + + +----------- +DESCRIPTION +----------- + + +These functions generate hash values from a key using a variety of +algorithms. These functions can be used standalone, or as arguments +to hashkit_set_hash_fn(3) or hashkit_set_continuum_hash_fn(3). + +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: +`http://libmemcached.org/ <http://libmemcached.org/>`_ + + +-------- +SEE ALSO +-------- + + +:manpage:`hashkit_create(3)` :manpage:`hashkit_value(3)` :manpage:`hashkit_set_hash_fn(3)` :manpage:`hashkit_set_continuum_hash_fn(3)` + |