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

   1 =head1 NAME
   2
   3 hashkit_value - Generate a value for the given key
   4
   5 =head1 LIBRARY
   6
   7 C Library for hashing algorithms (libhashkit, -lhashkit)
   8
   9 =head1 SYNOPSIS
  10
  11   #include <libhashkit/hashkit.h>
  12
  13   uint32_t hashkit_value(hashkit_st *hash,
  14                          const char *key,
  15                          size_t key_length);
  16
  17 =head1 DESCRIPTION
  18
  19 The 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 =head1 RETURN VALUE
  25
  26 A 32-bit hash value.
  27
  28 =head1 HOME
  29
  30 To find out more information please check:
  31 L<https://launchpad.net/libmemcached>
  32
  33 =head1 AUTHOR
  34
  35 Brian Aker, E<lt>brian@tangent.orgE<gt>
  36
  37 =head1 SEE ALSO
  38
  39 hashkit_create(3) hashkit_set_distribution(3) hashkit_set_hash_fn(3)
  40
  41 =cut