X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_create.pod;h=8d1a76b47be3df68cbb00429bb039c0bdbe825a5;hb=3793fdb392266c08b59b2e5815f9db6a60c48fda;hp=cbe6fc1ee91c6accde864424b66133bfb294d384;hpb=7add2cb42be7d072888ab916eb35cdef8a2774a1;p=awesomized%2Flibmemcached diff --git a/docs/memcached_create.pod b/docs/memcached_create.pod index cbe6fc1e..8d1a76b4 100755 --- a/docs/memcached_create.pod +++ b/docs/memcached_create.pod @@ -14,6 +14,8 @@ C Client Library for memcached (libmemcached, -lmemcached) void memcached_free (memcached_st *ptr); + memcached_st *memcached_clone(memcached_st *clone, memcached_st *source); + =head1 DESCRIPTION memcached_create() is used to create a C structure that will then @@ -21,6 +23,11 @@ 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 clone argument is NULL a C will be allocated for you. + 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 @@ -31,6 +38,10 @@ the structure. 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. If you pass in +a preallocated structure it must be cleared first (aka memset()). + =head1 HOME To find out more information please check: