X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_create.pod;h=4323723b722101420a6f5ea991831caf29bb732b;hb=9c7e4d791a127f8ae46aaddc531319da1f34b5ba;hp=cbe6fc1ee91c6accde864424b66133bfb294d384;hpb=7add2cb42be7d072888ab916eb35cdef8a2774a1;p=m6w6%2Flibmemcached diff --git a/docs/memcached_create.pod b/docs/memcached_create.pod old mode 100755 new mode 100644 index cbe6fc1e..4323723b --- a/docs/memcached_create.pod +++ b/docs/memcached_create.pod @@ -1,6 +1,6 @@ =head1 NAME -memcached_create, memcached_free +memcached_create, memcached_free, memcached_clone, memcached_servers_reset- Create a memcached_st structure =head1 LIBRARY @@ -14,6 +14,10 @@ C Client Library for memcached (libmemcached, -lmemcached) void memcached_free (memcached_st *ptr); + memcached_st *memcached_clone (memcached_st *destination, memcached_st *source); + + void memcached_servers_reset(memcached_st); + =head1 DESCRIPTION memcached_create() is used to create a C structure that will then @@ -21,20 +25,35 @@ be used by other libmemcached(3) functions to communicate with the server. You should either pass a statically declared C to memcached_create() or a NULL. If a NULL passed in then a structure is allocated for you. +memcached_clone() is similar to memcached_create(3) but it copies the +defaults and list of servers from the source C. If you pass a null as +the argument for the source to clone, it is the same as a call to memcached_create(). +If the destination argument is NULL a C will be allocated for you. + +memcached_servers_reset() allows you to zero out the list of servers that +the memcached_st has. + To clean up memory associated with a C structure you should pass it to memcached_free() when you are finished using it. memcached_free() is the only way to make sure all memory is deallocated when you finish using the structure. +You may wish to avoid using memcached_create(3) or memcached_clone(3) with a +stack based allocation. The most common issues related to ABI safety involve +heap allocated structures. + =head1 RETURN memcached_create() returns a pointer to the memcached_st that was created (or initialized). On an allocation failure, it returns NULL. +memcached_clone() returns a pointer to the memcached_st that was created +(or initialized). On an allocation failure, it returns NULL. + =head1 HOME To find out more information please check: -L +L =head1 AUTHOR