Update for docs
[awesomized/libmemcached] / docs / man / memcached_servers_reset.3
1 .TH "MEMCACHED_SERVERS_RESET" "3" "April 08, 2011" "0.47" "libmemcached"
2 .SH NAME
3 memcached_servers_reset \- 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 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 memcached_st *memcached_create (memcached_st *ptr);
45
46 void memcached_free (memcached_st *ptr);
47
48 memcached_st *memcached_clone (memcached_st *destination, memcached_st *source);
49
50 void memcached_servers_reset(memcached_st);
51 .ft P
52 .fi
53 .SH DESCRIPTION
54 .sp
55 memcached_create() is used to create a \fBmemcached_st\fP structure that will then
56 be used by other libmemcached(3) functions to communicate with the server. You
57 should either pass a statically declared \fBmemcached_st\fP to memcached_create() or
58 a NULL. If a NULL passed in then a structure is allocated for you.
59 .sp
60 memcached_clone() is similar to memcached_create(3) but it copies the
61 defaults and list of servers from the source \fBmemcached_st\fP. If you pass a null as
62 the argument for the source to clone, it is the same as a call to memcached_create().
63 If the destination argument is NULL a \fBmemcached_st\fP will be allocated for you.
64 .sp
65 memcached_servers_reset() allows you to zero out the list of servers that
66 the memcached_st has.
67 .sp
68 To clean up memory associated with a \fBmemcached_st\fP structure you should pass
69 it to memcached_free() when you are finished using it. memcached_free() is
70 the only way to make sure all memory is deallocated when you finish using
71 the structure.
72 .sp
73 You may wish to avoid using memcached_create(3) or memcached_clone(3) with a
74 stack based allocation. The most common issues related to ABI safety involve
75 heap allocated structures.
76 .SH RETURN
77 .sp
78 memcached_create() returns a pointer to the memcached_st that was created
79 (or initialized). On an allocation failure, it returns NULL.
80 .sp
81 memcached_clone() returns a pointer to the memcached_st that was created
82 (or initialized). On an allocation failure, it returns NULL.
83 .SH HOME
84 .sp
85 To find out more information please check:
86 \fI\%https://launchpad.net/libmemcached\fP
87 .SH AUTHOR
88 .sp
89 Brian Aker, <\fI\%brian@tangent.org\fP>
90 .SH SEE ALSO
91 .sp
92 memcached(1) libmemcached(3) memcached_strerror(3)
93 .SH AUTHOR
94 Brian Aker
95 .SH COPYRIGHT
96 2011, Brian Aker
97 .\" Generated by docutils manpage writer.
98 .\"
99 .