1 ======================================
2 Creating and destroying a memcached_st
3 ======================================
9 #include <libmemcached/memcached.h>
11 .. type:: memcached_st
13 .. function:: memcached_st* memcached_create(memcached_st *ptr)
15 .. function:: void memcached_free(memcached_st *ptr)
17 .. function:: memcached_st* memcached_clone(memcached_st *destination, memcached_st *source)
19 .. function:: void memcached_servers_reset(memcached_st)
21 Compile and link with -lmemcached
28 :func:`memcached_create` is used to create a :type:`memcached_st`
29 structure that will then be used by other libmemcached(3) functions to
30 communicate with the server. You should either pass a statically declared
31 :type:`memcached_st` to :func:`memcached_create` or
32 a NULL. If a NULL passed in then a structure is allocated for you.
34 Please note, when you write new application use
35 :func:`memcached` over :func:`memcached_create`.
37 :func:`memcached_clone` is similar to :func:`memcached_create` but
38 it copies the defaults and list of servers from the source
39 :type:`memcached_st`. If you pass a null as the argument for the source
40 to clone, it is the same as a call to :func:`memcached_create`.
41 If the destination argument is NULL a :type:`memcached_st` will be allocated
44 :func:`memcached_servers_reset` allows you to zero out the list of
45 servers that the :type:`memcached_st` has.
47 To clean up memory associated with a :type:`memcached_st` structure you
48 should pass it to :func:`memcached_free` when you are finished using it.
49 :func:`memcached_free` is the only way to make sure all memory is
50 deallocated when you finish using the structure.
52 You may wish to avoid using memcached_create(3) or memcached_clone(3) with a
53 stack based allocation. The most common issues related to ABI safety involve
54 heap allocated structures.
62 :func:`memcached_create` returns a pointer to the :type:`memcached_st`
63 that was created (or initialized). On an allocation failure, it returns NULL.
65 :func:`memcached_clone` returns a pointer to the :type:`memcached_st`
66 that was created (or initialized). On an allocation failure, it returns NULL.
75 :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`