65d3f6eca966691675638a0a312d9d32f67a03f1
[awesomized/libmemcached] / docs / man / memcached_clone.3
1 .TH "MEMCACHED_CLONE" "3" "April 14, 2011" "0.47" "libmemcached"
2 .SH NAME
3 memcached_clone \- 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 Create a memcached_st structure
35 .SH SYNOPSIS
36 .sp
37 #include <libmemcached/memcached.h>
38 .INDENT 0.0
39 .TP
40 .B memcached_st *memcached_create (memcached_st *ptr);
41 .UNINDENT
42 .INDENT 0.0
43 .TP
44 .B void memcached_free (memcached_st *ptr);
45 .UNINDENT
46 .INDENT 0.0
47 .TP
48 .B memcached_st *memcached_clone (memcached_st *destination, memcached_st *source);
49 .UNINDENT
50 .INDENT 0.0
51 .TP
52 .B void memcached_servers_reset(memcached_st);
53 .UNINDENT
54 .sp
55 Compile and link with \-lmemcached
56 .SH DESCRIPTION
57 .sp
58 memcached_create() is used to create a \fBmemcached_st\fP structure that will then
59 be used by other libmemcached(3) functions to communicate with the server. You
60 should either pass a statically declared \fBmemcached_st\fP to memcached_create() or
61 a NULL. If a NULL passed in then a structure is allocated for you.
62 .sp
63 Please note, when you write new application use memcached_create_with_options() over memcached_create().
64 .sp
65 memcached_clone() is similar to memcached_create(3) but it copies the
66 defaults and list of servers from the source \fBmemcached_st\fP. If you pass a null as
67 the argument for the source to clone, it is the same as a call to memcached_create().
68 If the destination argument is NULL a \fBmemcached_st\fP will be allocated for you.
69 .sp
70 memcached_servers_reset() allows you to zero out the list of servers that
71 the memcached_st has.
72 .sp
73 To clean up memory associated with a \fBmemcached_st\fP structure you should pass
74 it to memcached_free() when you are finished using it. memcached_free() is
75 the only way to make sure all memory is deallocated when you finish using
76 the structure.
77 .sp
78 You may wish to avoid using memcached_create(3) or memcached_clone(3) with a
79 stack based allocation. The most common issues related to ABI safety involve
80 heap allocated structures.
81 .SH RETURN
82 .sp
83 memcached_create() returns a pointer to the memcached_st that was created
84 (or initialized). On an allocation failure, it returns NULL.
85 .sp
86 memcached_clone() returns a pointer to the memcached_st that was created
87 (or initialized). On an allocation failure, it returns NULL.
88 .SH HOME
89 .sp
90 To find out more information please check:
91 \fI\%http://libmemcached.org/\fP
92 .SH SEE ALSO
93 .sp
94 \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
95 .SH AUTHOR
96 Brian Aker
97 .SH COPYRIGHT
98 2011, Brian Aker DataDifferential, http://datadifferential.com/
99 .\" Generated by docutils manpage writer.
100 .\"
101 .