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

   1 =============
   2 hashkit_value
   3 =============
   4
   5
   6 .. index:: object: hashkit_st
   7
   8 Generate a value for the given key
   9
  10 --------
  11 SYNOPSIS
  12 --------
  13
  14
  15 #include <libhashkit/hashkit.h>
  16
  17 .. c:function:: uint32_t hashkit_value(hashkit_st *hash, const char *key, size_t key_length);
  18
  19
  20 Compile and link with -lhashkit
  21
  22
  23
  24 -----------
  25 DESCRIPTION
  26 -----------
  27
  28
  29 The :c:func:`hashkit_value()` function generates a 32-bit hash value from the
  30 given key and key_length. The hash argument is an initialized hashkit
  31 object, and distribution type and hash function is used from this
  32 object while generating the value.
  33
  34
  35 ------------
  36 RETURN VALUE
  37 ------------
  38
  39
  40 A 32-bit hash value.
  41
  42
  43 ----
  44 HOME
  45 ----
  46
  47
  48 To find out more information please check:
  49 `http://libmemcached.org/ <http://libmemcached.org/>`_
  50
  51
  52 --------
  53 SEE ALSO
  54 --------
  55
  56
  57 :manpage:`hashkit_create(3)` :manpage:`hashkit_set_distribution(3)` :manpage:`hashkit_set_hash_fn(3)`
  58