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 DESCRIPTION
  13 -----------
  14
  15 The `hashkit_value` function generates a 32-bit hash value from the given key
  16 and key_length. The hash argument is an initialized hashkit object, and
  17 distribution type and hash function is used from this object while generating
  18 the value.
  19
  20 RETURN VALUE
  21 ------------
  22
  23 A 32-bit hash value.
  24
  25 SEE ALSO
  26 --------
  27
  28 .. only:: man
  29
  30     :manpage:`libhashkit(3)`
  31     :manpage:`hashkit_create(3)`
  32     :manpage:`hashkit_function(3)`
  33     :manpage:`hashkit_functions(3)`
  34
  35 .. only:: html
  36
  37     * :doc:`../libhashkit`
  38     * :doc:`hashkit_create`
  39     * :doc:`hashkit_function`
  40     * :doc:`hashkit_functions`
  41