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

   1 .TH "MEMCACHED_GENERATE_HASH_VALUE" "3" "April 09, 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 Hash a key value
  35 .SH LIBRARY
  36 .sp
  37 C Client Library for memcached (libmemcached, \-lmemcached)
  38 .SH SYNOPSIS
  39 .sp
  40 .nf
  41 .ft C
  42 #include <libmemcached/memcached.h>
  43
  44 uint32_t
  45   memcached_generate_hash_value (const char *key,
  46                                  size_t key_length,
  47                                  memcached_hash_t hash_algorithm);
  48
  49 uint32_t
  50   memcached_generate_hash (memcached_st *ptr,
  51                            const char *key,
  52                            size_t key_length);
  53 .ft P
  54 .fi
  55 .SH DESCRIPTION
  56 .sp
  57 memcached_generate_hash_value() allows you to hash a key using one of
  58 the hash functions defined in the library. This method is provided for
  59 the convenience of higher\-level language bindings and is not necessary
  60 for normal memcache operations.
  61 .sp
  62 The allowed hash algorithm constants are listed in the manpage for
  63 memcached_behavior_set().
  64 .sp
  65 memcached_generate_hash() takes a memcached_st struture and produces
  66 the hash value that would have been generated based on the defaults
  67 of the memcached_st structure.
  68 .sp
  69 As of version 0.36 all hash methods have been placed into the library
  70 libhashkit(3) which is linked with libmemcached(3). For more information please see its documentation.
  71 .SH RETURN
  72 .sp
  73 A 32\-bit integer which is the result of hashing the given key.
  74 For 64\-bit hash algorithms, only the least\-significant 32 bits are
  75 returned.
  76 .SH HOME
  77 .sp
  78 To find out more information please check:
  79 \fI\%https://launchpad.net/libmemcached\fP
  80 .SH AUTHOR
  81 .sp
  82 Brian Aker, <\fI\%brian@tangent.org\fP>
  83 .SH SEE ALSO
  84 .sp
  85 \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
  86 .SH AUTHOR
  87 Brian Aker
  88 .SH COPYRIGHT
  89 2011, Brian Aker DataDifferential, http://datadifferential.com/
  90 .\" Generated by docutils manpage writer.
  91 .\"
  92 .