aeb33a23a937933cfd03152bb14d7d645f396627
[awesomized/libmemcached] / docs / man / hashkit_value.3
1 .TH "HASHKIT_VALUE" "3" "April 14, 2011" "0.47" "libmemcached"
2 .SH NAME
3 hashkit_value \- libhashkit 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 Generate a value for the given key
35 .SH LIBRARY
36 .sp
37 C Library for hashing algorithms (libmemcached, \-lhashkit)
38 .SH SYNOPSIS
39 .sp
40 .nf
41 .ft C
42 #include <libmemcached/hashkit.h>
43
44 uint32_t hashkit_value(hashkit_st *hash,
45 const char *key,
46 size_t key_length);
47 .ft P
48 .fi
49 .SH DESCRIPTION
50 .sp
51 The hashkit_value() function generates a 32\-bit hash value from the
52 given key and key_length. The hash argument is an initialized hashkit
53 object, and distribution type and hash function is used from this
54 object while generating the value.
55 .SH RETURN VALUE
56 .sp
57 A 32\-bit hash value.
58 .SH HOME
59 .sp
60 To find out more information please check:
61 \fI\%http://libmemcached.org/\fP
62 .SH SEE ALSO
63 .sp
64 hashkit_create(3) hashkit_set_distribution(3) hashkit_set_hash_fn(3)
65 .SH AUTHOR
66 Brian Aker
67 .SH COPYRIGHT
68 2011, Brian Aker DataDifferential, http://datadifferential.com/
69 .\" Generated by docutils manpage writer.
70 .\"
71 .