git.m6w6.name Git - m6w6/libmemcached/blob - docs/man/memcached_generate_hash_value.3

   1 .TH "MEMCACHED_GENERATE_HASH_VALUE" "3" "April 08, 2011" "0.47" "libmemcached"
   2 .SH NAME
   3 memcached_generate_hash_value \- libmemcached Documentation
   4 .
   5 .nr rst2man-indent-level 0
   6 .
   7 .de1 rstReportMargin
   8 \\$1 \\n[an-margin]
   9 level \\n[rst2man-indent-level]
  10 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  11 -
  12 \\n[rst2man-indent0]
  13 \\n[rst2man-indent1]
  14 \\n[rst2man-indent2]
  15 ..
  16 .de1 INDENT
  17 .\" .rstReportMargin pre:
  18 . RS \\$1
  19 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  20 . nr rst2man-indent-level +1
  21 .\" .rstReportMargin post:
  22 ..
  23 .de UNINDENT
  24 . RE
  25 .\" indent \\n[an-margin]
  26 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  27 .nr rst2man-indent-level -1
  28 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  29 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  30 ..
  31 .\" Man page generated from reStructeredText.
  32 .
  33 .sp
  34 memcached_generate_hash_value
  35 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-**
  36 .sp
  37 Hash a key value
  38 .sp
  39 C Client Library for memcached (libmemcached, \-lmemcached)
  40 .SH SYNOPSIS
  41 .sp
  42 .nf
  43 .ft C
  44 #include <libmemcached/memcached.h>
  45
  46 uint32_t
  47   memcached_generate_hash_value (const char *key,
  48                                  size_t key_length,
  49                                  memcached_hash_t hash_algorithm);
  50
  51 uint32_t
  52   memcached_generate_hash (memcached_st *ptr,
  53                            const char *key,
  54                            size_t key_length);
  55 .ft P
  56 .fi
  57 .SH DESCRIPTION
  58 .sp
  59 memcached_generate_hash_value() allows you to hash a key using one of
  60 the hash functions defined in the library. This method is provided for
  61 the convenience of higher\-level language bindings and is not necessary
  62 for normal memcache operations.
  63 .sp
  64 The allowed hash algorithm constants are listed in the manpage for
  65 memcached_behavior_set().
  66 .sp
  67 memcached_generate_hash() takes a memcached_st struture and produces
  68 the hash value that would have been generated based on the defaults
  69 of the memcached_st structure.
  70 .sp
  71 As of version 0.36 all hash methods have been placed into the library
  72 libmemcached(3) which is linked with libmemcached(3).
  73 .sp
  74 A 32\-bit integer which is the result of hashing the given key.
  75 For 64\-bit hash algorithms, only the least\-significant 32 bits are
  76 returned.
  77 .sp
  78 To find out more information please check:
  79 \fI\%https://launchpad.net/libmemcached\fP
  80 .sp
  81 Brian Aker, <\fI\%brian@tangent.org\fP>
  82 .SH SEE ALSO
  83 .sp
  84 \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
  85 .SH AUTHOR
  86 Brian Aker
  87 .SH COPYRIGHT
  88 2011, Brian Aker
  89 .\" Generated by docutils manpage writer.
  90 .\"
  91 .