blob: 9a5defd488d38e3790a11ca50d0a27f1f6dfb08e (
plain)
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
|
.TH "HASHKIT_CLONE" "3" "September 16, 2012" "1.0.10" "libmemcached"
.SH NAME
hashkit_clone \- libhashkit Documentation
.
.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.
.
.SH SYNOPSIS
.sp
#include <libhashkit/hashkit.h>
.INDENT 0.0
.TP
.B hashkit_st
.UNINDENT
.INDENT 0.0
.TP
.B \fI\%hashkit_st\fP *hashkit_create(\fI\%hashkit_st\fP\fI\ *hash\fP)
.UNINDENT
.INDENT 0.0
.TP
.B \fI\%hashkit_st\fP *hashkit_clone(\fI\%hashkit_st\fP\fI\ *destination\fP, const \fI\%hashkit_st\fP\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
.B void hashkit_free(\fI\%hashkit_st\fP\fI\ *hash\fP)
.UNINDENT
.INDENT 0.0
.TP
.B bool hashkit_is_allocated(const \fI\%hashkit_st\fP\fI\ *hash\fP)
.UNINDENT
.sp
Compile and link with \-lhashkit
.SH DESCRIPTION
.sp
The \fI\%hashkit_create()\fP function initializes a hashkit object for use. If
you pass a NULL argument for hash, then the memory for the object is
allocated. If you specify a pre\-allocated piece of memory, that is
initialized for use.
.sp
The \fI\%hashkit_clone()\fP function initializes a hashkit object much like
\fI\%hashkit_create()\fP, but instead of using default settings it will use
the settings of the ptr hashkit object.
.sp
The \fI\%hashkit_free()\fP frees any resources being consumed by the hashkit
objects that were initialized with \fI\%hashkit_create()\fP or \fI\%hashkit_clone()\fP.
.sp
The \fI\%hashkit_is_allocated()\fP reports where the memory was allocated
for a hashkit object.
.SH RETURN VALUE
.sp
\fI\%hashkit_create()\fP and \fI\%hashkit_clone()\fP will return NULL on
failure or non\-NULL on success.
.sp
\fI\%hashkit_is_allocated()\fP returns true if the memory for the hashkit
object was allocated inside of \fI\%hashkit_create()\fP or
\fI\%hashkit_clone()\fP, otherwise it is false and was user\-supplied memory.
.SH HOME
.sp
To find out more information please check:
\fI\%http://libmemcached.org/\fP
.SH SEE ALSO
.sp
\fIhashkit_create(3)\fP \fIhashkit_value(3)\fP \fIhashkit_set_hash_fn(3)\fP
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
2011-2012, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\"
.
|
