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

   1 =head1 NAME
   2
   3 memcached_generate_hash_value - Hash a key value
   4
   5 =head1 LIBRARY
   6
   7 C Client Library for memcached (libmemcached, -lmemcached)
   8
   9 =head1 SYNOPSIS
  10
  11   #include <memcached.h>
  12
  13   uint32_t
  14     memcached_generate_hash_value (const char *key,
  15                                    size_t key_length,
  16                                    memcached_hash hash_algorithm);
  17
  18 =head1 DESCRIPTION
  19
  20 memcached_generate_hash_value() allows you to hash a key using one of
  21 the hash fuctions defined in the library. This method is provided for
  22 the convenience of higher-level language bindings and is not necessary
  23 for normal memcache operations.
  24
  25 The allowed hash algorithm constants are listed in the manpage for
  26 memcached_behavior_set().
  27
  28 =head1 RETURN
  29
  30 A 32-bit integer which is the result of hashing the given key.
  31 For 64-bit hash algorithms, only the least-significant 32 bits are
  32 returned.
  33
  34 =head1 HOME
  35
  36 To find out more information please check:
  37 L<http://tangent.org/552/libmemcached.html>
  38
  39 =head1 AUTHOR
  40
  41 Brian Aker, E<lt>brian@tangent.orgE<gt>
  42
  43 =head1 SEE ALSO
  44
  45 memcached(1) libmemcached(3) memcached_behavior_set(3)
  46
  47 =cut
  48