9 memcached_create, memcached_free, memcached_clone, memcached_servers_reset- Create a memcached_st structure
17 C Client Library for memcached (libmemcached, -lmemcached)
28 #include <memcached.h>
30 memcached_st *memcached_create (memcached_st *ptr);
32 void memcached_free (memcached_st *ptr);
34 memcached_st *memcached_clone (memcached_st *destination, memcached_st *source);
36 void memcached_servers_reset(memcached_st);
45 memcached_create() is used to create a \ ``memcached_st``\ structure that will then
46 be used by other libmemcached(3) functions to communicate with the server. You
47 should either pass a statically declared \ ``memcached_st``\ to memcached_create() or
48 a NULL. If a NULL passed in then a structure is allocated for you.
50 memcached_clone() is similar to memcached_create(3) but it copies the
51 defaults and list of servers from the source \ ``memcached_st``\ . If you pass a null as
52 the argument for the source to clone, it is the same as a call to memcached_create().
53 If the destination argument is NULL a \ ``memcached_st``\ will be allocated for you.
55 memcached_servers_reset() allows you to zero out the list of servers that
58 To clean up memory associated with a \ ``memcached_st``\ structure you should pass
59 it to memcached_free() when you are finished using it. memcached_free() is
60 the only way to make sure all memory is deallocated when you finish using
63 You may wish to avoid using memcached_create(3) or memcached_clone(3) with a
64 stack based allocation. The most common issues related to ABI safety involve
65 heap allocated structures.
73 memcached_create() returns a pointer to the memcached_st that was created
74 (or initialized). On an allocation failure, it returns NULL.
76 memcached_clone() returns a pointer to the memcached_st that was created
77 (or initialized). On an allocation failure, it returns NULL.
85 To find out more information please check:
86 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
94 Brian Aker, <brian@tangent.org>
102 memcached(1) libmemcached(3) memcached_strerror(3)