memcached_create(3)

1memcached_create.pop(3)        memcached_create        memcached_create.pop(3)
2
3
4

NAME

6       memcached_create, memcached_free, memcached_clone,
7       memcached_servers_reset- Create a memcached_st structure
8

LIBRARY

10       C Client Library for memcached (libmemcached, -lmemcached)
11

SYNOPSIS

13         #include <memcached.h>
14
15         memcached_st *memcached_create (memcached_st *ptr);
16
17         void memcached_free (memcached_st *ptr);
18
19         memcached_st *memcached_clone (memcached_st *destination, memcached_st *source);
20
21         void memcached_servers_reset(memcached_st);
22

DESCRIPTION

24       memcached_create() is used to create a "memcached_st" structure that
25       will then be used by other libmemcached(3) functions to communicate
26       with the server. You should either pass a statically declared
27       "memcached_st" to memcached_create() or a NULL. If a NULL passed in
28       then a structure is allocated for you.
29
30       memcached_clone() is similar to memcached_create(3) but it copies the
31       defaults and list of servers from the source "memcached_st". If you
32       pass a null as the argument for the source to clone, it is the same as
33       a call to memcached_create().  If the destination argument is NULL a
34       "memcached_st" will be allocated for you.
35
36       memcached_servers_reset() allows you to zero out the list of servers
37       that the memcached_st has.
38
39       To clean up memory associated with a "memcached_st" structure you
40       should pass it to memcached_free() when you are finished using it.
41       memcached_free() is the only way to make sure all memory is deallocated
42       when you finish using the structure.
43
44       You may wish to avoid using memcached_create(3) or memcached_clone(3)
45       with a stack based allocation. The most common issues related to ABI
46       safety involve heap allocated structures.
47

RETURN

49       memcached_create() returns a pointer to the memcached_st that was
50       created (or initialized). On an allocation failure, it returns NULL.
51
52       memcached_clone() returns a pointer to the memcached_st that was
53       created (or initialized). On an allocation failure, it returns NULL.
54

HOME

56       To find out more information please check:
57       <https://launchpad.net/libmemcached>
58

AUTHOR

60       Brian Aker, <brian@tangent.org>
61