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

   1 Generate hash value
   2 ===================
   3
   4 .. index:: object: hashkit_st
   5
   6 Generate a value for the given key
   7
   8 SYNOPSIS
   9 --------
  10
  11 #include <libhashkit-|libhashkit_version|/hashkit.h>
  12   Compile and link with -lhashkit
  13
  14 .. c:function:: uint32_t hashkit_value(hashkit_st *hash, const char *key, size_t key_length)
  15
  16 DESCRIPTION
  17 -----------
  18
  19 The :c:func:`hashkit_value` function generates a 32-bit hash value from the
  20 given key and key_length. The hash argument is an initialized hashkit
  21 object, and distribution type and hash function is used from this
  22 object while generating 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