1 .TH "MEMCACHED_FREE" "3" "April 09, 2011" "0.47" "libmemcached"
3 memcached_free \- libmemcached Documentation
5 .nr rst2man-indent-level 0
9 level \\n[rst2man-indent-level]
10 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
17 .\" .rstReportMargin pre:
19 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
20 . nr rst2man-indent-level +1
21 .\" .rstReportMargin post:
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
31 .\" Man page generated from reStructeredText.
34 Create a memcached_st structure
37 C Client Library for memcached (libmemcached, \-lmemcached)
40 #include <libmemcached/memcached.h>
43 .B memcached_st *memcached_create (memcached_st *ptr);
47 .B void memcached_free (memcached_st *ptr);
51 .B memcached_st *memcached_clone (memcached_st *destination, memcached_st *source);
55 .B void memcached_servers_reset(memcached_st);
59 memcached_create() is used to create a \fBmemcached_st\fP structure that will then
60 be used by other libmemcached(3) functions to communicate with the server. You
61 should either pass a statically declared \fBmemcached_st\fP to memcached_create() or
62 a NULL. If a NULL passed in then a structure is allocated for you.
64 memcached_clone() is similar to memcached_create(3) but it copies the
65 defaults and list of servers from the source \fBmemcached_st\fP. If you pass a null as
66 the argument for the source to clone, it is the same as a call to memcached_create().
67 If the destination argument is NULL a \fBmemcached_st\fP will be allocated for you.
69 memcached_servers_reset() allows you to zero out the list of servers that
72 To clean up memory associated with a \fBmemcached_st\fP structure you should pass
73 it to memcached_free() when you are finished using it. memcached_free() is
74 the only way to make sure all memory is deallocated when you finish using
77 You may wish to avoid using memcached_create(3) or memcached_clone(3) with a
78 stack based allocation. The most common issues related to ABI safety involve
79 heap allocated structures.
82 memcached_create() returns a pointer to the memcached_st that was created
83 (or initialized). On an allocation failure, it returns NULL.
85 memcached_clone() returns a pointer to the memcached_st that was created
86 (or initialized). On an allocation failure, it returns NULL.
89 To find out more information please check:
90 \fI\%https://launchpad.net/libmemcached\fP
93 Brian Aker, <\fI\%brian@tangent.org\fP>
96 \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
100 2011, Brian Aker DataDifferential, http://datadifferential.com/
101 .\" Generated by docutils manpage writer.