1 ======================================
2 Creating and destroying a memcached_st
3 ======================================
6 Create a memcached_st structure
14 C Client Library for memcached (libmemcached, -lmemcached)
25 #include <libmemcached/memcached.h>
27 memcached_st *memcached_create (memcached_st *ptr);
29 void memcached_free (memcached_st *ptr);
31 memcached_st *memcached_clone (memcached_st *destination, memcached_st *source);
33 void memcached_servers_reset(memcached_st);
42 memcached_create() is used to create a \ ``memcached_st``\ structure that will then
43 be used by other libmemcached(3) functions to communicate with the server. You
44 should either pass a statically declared \ ``memcached_st``\ to memcached_create() or
45 a NULL. If a NULL passed in then a structure is allocated for you.
47 memcached_clone() is similar to memcached_create(3) but it copies the
48 defaults and list of servers from the source \ ``memcached_st``\ . If you pass a null as
49 the argument for the source to clone, it is the same as a call to memcached_create().
50 If the destination argument is NULL a \ ``memcached_st``\ will be allocated for you.
52 memcached_servers_reset() allows you to zero out the list of servers that
55 To clean up memory associated with a \ ``memcached_st``\ structure you should pass
56 it to memcached_free() when you are finished using it. memcached_free() is
57 the only way to make sure all memory is deallocated when you finish using
60 You may wish to avoid using memcached_create(3) or memcached_clone(3) with a
61 stack based allocation. The most common issues related to ABI safety involve
62 heap allocated structures.
70 memcached_create() returns a pointer to the memcached_st that was created
71 (or initialized). On an allocation failure, it returns NULL.
73 memcached_clone() returns a pointer to the memcached_st that was created
74 (or initialized). On an allocation failure, it returns NULL.
82 To find out more information please check:
83 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
91 Brian Aker, <brian@tangent.org>
99 :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`