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

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