diff options
Diffstat (limited to 'docs/source/hashkit_value.rst')
| -rw-r--r-- | docs/source/hashkit_value.rst | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/docs/source/hashkit_value.rst b/docs/source/hashkit_value.rst new file mode 100644 index 00000000..d27e3528 --- /dev/null +++ b/docs/source/hashkit_value.rst @@ -0,0 +1,55 @@ +============= +hashkit_value +============= + + +.. index:: object: hashkit_st + +Generate a value for the given key + +-------- +SYNOPSIS +-------- + + +#include <libhashkit/hashkit.h> + +.. c:function:: uint32_t hashkit_value(hashkit_st *hash, const char *key, size_t key_length) + +Compile and link with -lhashkit + +----------- +DESCRIPTION +----------- + + +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: +`http://libmemcached.org/ <http://libmemcached.org/>`_ + + +-------- +SEE ALSO +-------- + + +:manpage:`hashkit_create(3)` :manpage:`hashkit_set_distribution(3)` :manpage:`hashkit_set_hash_fn(3)` + |