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

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