docs/man/memcached_generate_hash_value.3


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

.TH "MEMCACHED_GENERATE_HASH_VALUE" "3" "August 02, 2012" "1.0.10" "libmemcached"
.SH NAME
memcached_generate_hash_value \- Generating hash values directly
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" Man page generated from reStructeredText.
.
.sp
Hash a key value
.SH SYNOPSIS
.sp
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
.B memcached_hash_t
.UNINDENT
.INDENT 0.0
.TP
.B uint32_t memcached_generate_hash_value(const char\fI\ *key\fP, size_t\fI\ key_length\fP, \fI\%memcached_hash_t\fP\fI\ hash_algorithm\fP)
.UNINDENT
.INDENT 0.0
.TP
.B uint32_t memcached_generate_hash(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
.B MEMCACHED_HASH_DEFAULT
.UNINDENT
.INDENT 0.0
.TP
.B MEMCACHED_HASH_MD5
.UNINDENT
.INDENT 0.0
.TP
.B MEMCACHED_HASH_CRC
.UNINDENT
.INDENT 0.0
.TP
.B MEMCACHED_HASH_FNV1_64
.UNINDENT
.INDENT 0.0
.TP
.B MEMCACHED_HASH_FNV1A_64
.UNINDENT
.INDENT 0.0
.TP
.B MEMCACHED_HASH_FNV1_32
.UNINDENT
.INDENT 0.0
.TP
.B MEMCACHED_HASH_FNV1A_32
.UNINDENT
.INDENT 0.0
.TP
.B MEMCACHED_HASH_JENKINS
.UNINDENT
.INDENT 0.0
.TP
.B MEMCACHED_HASH_MURMUR
.UNINDENT
.INDENT 0.0
.TP
.B MEMCACHED_HASH_HSIEH
.UNINDENT
.sp
Compile and link with \-lmemcachedutil \-lmemcached
.SH DESCRIPTION
.sp
\fI\%memcached_generate_hash_value()\fP allows you to hash a key using one of
the hash functions defined in the library. This method is provided for
the convenience of higher\-level language bindings and is not necessary
for normal memcache operations.
.sp
The allowed hash algorithm constants are listed in the manpage for
\fBmemcached_behavior_set()\fP.
.sp
\fI\%memcached_generate_hash()\fP takes a \fBmemcached_st\fP struture
and produces the hash value that would have been generated based on the
defaults of \fBmemcached_st\fP.
.sp
As of version 0.36 all hash methods have been placed into the library
libhashkit(3) which is linked with libmemcached(3). For more information please see its documentation.
.SH RETURN
.sp
A 32\-bit integer which is the result of hashing the given key.
For 64\-bit hash algorithms, only the least\-significant 32 bits are
returned.
.SH HOME
.sp
To find out more information please check:
\fI\%http://libmemcached.org/\fP
.SH AUTHOR
.sp
Brian Aker, <\fI\%brian@tangent.org\fP>
.SH SEE ALSO
.sp
\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\" 
.