Sha256: d8e6e9e9eb8e1ff2207bf4a45cd855111741ee6de588bfe4035feb9d49b941cf
Contents?: true
Size: 1.98 KB
Versions: 19
Compression:
Stored size: 1.98 KB
Contents
=head1 NAME memcached_create, memcached_free - Create a memcached_st structure =head1 LIBRARY C Client Library for memcached (libmemcached, -lmemcached) =head1 SYNOPSIS #include <memcached.h> memcached_st *memcached_create (memcached_st *ptr); 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<memcached_st> structure that will then be used by other libmemcached(3) functions to communicate with the server. You should either pass a statically declared C<memcached_st> 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<memcached_st>. 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<memcached_st> will be allocated for you. If you pass a pointer to a memory area for the clone pointer, make sure you memset it to 0 (unless you got the clone from a factory method in libmemcached). To clean up memory associated with a C<memcached_st> 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. =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. If you pass in a preallocated structure it must be cleared first (aka memset()). =head1 HOME To find out more information please check: L<http://tangent.org/552/libmemcached.html> =head1 AUTHOR Brian Aker, E<lt>brian@tangent.orgE<gt> =head1 SEE ALSO memcached(1) libmemcached(3) memcached_strerror(3) =cut
Version data entries
19 entries across 19 versions & 2 rubygems