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

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