Daisuke Maki > Memcached-libmemcached-0.3102 > memcached_create

Download:
Memcached-libmemcached-0.3102.tar.gz

Annotate this POD

CPAN RT

New  1
Open  0
Stalled  5
View/Report Bugs
Source   Latest Release: Memcached-libmemcached-0.4202

NAME ^

memcached_create, memcached_free - Create a memcached_st structure

LIBRARY ^

C Client Library for memcached (libmemcached, -lmemcached)

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);

DESCRIPTION ^

memcached_create() is used to create a 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 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 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 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 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.

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()).

HOME ^

To find out more information please check: http://tangent.org/552/libmemcached.html

AUTHOR ^

Brian Aker, <brian@tangent.org>

SEE ALSO ^

memcached(1) libmemcached(3) memcached_strerror(3)

syntax highlighting: