git.m6w6.name Git - awesomized/libmemcached/blob - docs/source/libhashkit/hashkit_value.rst

   1 Generate hash value
   2 ===================
   3
   4 SYNOPSIS
   5 --------
   6
   7 #include <libhashkit-|libhashkit_version|/hashkit.h>
   8   Compile and link with -lhashkit
   9
  10 .. function:: uint32_t hashkit_value(hashkit_st *hash, const char *key, size_t key_length)
  11
  12     :param hash: pointer to an initialized `hashkit_st` struct
  13     :param key: the key to genereate a hash of
  14     :param key_length: the length of the `key` without any terminating zero byte
  15
  16 DESCRIPTION
  17 -----------
  18
  19 The `hashkit_value` function generates a 32-bit hash value from the given key
  20 and key_length. The hash argument is an initialized hashkit object, and
  21 distribution type and hash function is used from this object while generating
  22 the value.
  23
  24 RETURN VALUE
  25 ------------
  26
  27 A 32-bit hash value.
  28
  29 SEE ALSO
  30 --------
  31
  32 .. only:: man
  33
  34     :manpage:`libhashkit(3)`
  35     :manpage:`hashkit_create(3)`
  36     :manpage:`hashkit_function(3)`
  37     :manpage:`hashkit_functions(3)`
  38
  39 .. only:: html
  40
  41     * :doc:`../libhashkit`
  42     * :doc:`hashkit_create`
  43     * :doc:`hashkit_function`
  44     * :doc:`hashkit_functions`
  45