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

   1 .. highlight:: perl
   2
   3
   4 ****
   5 NAME
   6 ****
   7
   8
   9 memcached_generate_hash_value - Hash a key value
  10
  11
  12 *******
  13 LIBRARY
  14 *******
  15
  16
  17 C Client Library for memcached (libmemcached, -lmemcached)
  18
  19
  20 ********
  21 SYNOPSIS
  22 ********
  23
  24
  25
  26 .. code-block:: perl
  27
  28    #include <memcached.h>
  29
  30    uint32_t
  31      memcached_generate_hash_value (const char *key,
  32                                     size_t key_length,
  33                                     memcached_hash_t hash_algorithm);
  34
  35    uint32_t
  36      memcached_generate_hash (memcached_st *ptr,
  37                               const char *key,
  38                               size_t key_length);
  39
  40
  41
  42 ***********
  43 DESCRIPTION
  44 ***********
  45
  46
  47 memcached_generate_hash_value() allows you to hash a key using one of
  48 the hash functions defined in the library. This method is provided for
  49 the convenience of higher-level language bindings and is not necessary
  50 for normal memcache operations.
  51
  52 The allowed hash algorithm constants are listed in the manpage for
  53 memcached_behavior_set().
  54
  55 memcached_generate_hash() takes a memcached_st struture and produces
  56 the hash value that would have been generated based on the defaults
  57 of the memcached_st structure.
  58
  59 As of version 0.36 all hash methods have been placed into the library
  60 libhashkit(3) which is linked with libmemcached(3).
  61
  62
  63 ******
  64 RETURN
  65 ******
  66
  67
  68 A 32-bit integer which is the result of hashing the given key.
  69 For 64-bit hash algorithms, only the least-significant 32 bits are
  70 returned.
  71
  72
  73 ****
  74 HOME
  75 ****
  76
  77
  78 To find out more information please check:
  79 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
  80
  81
  82 ******
  83 AUTHOR
  84 ******
  85
  86
  87 Brian Aker, <brian@tangent.org>
  88
  89
  90 ********
  91 SEE ALSO
  92 ********
  93
  94
  95 memcached(1) libmemcached(3) memcached_behavior_set(3) libhashkit(3)
  96