git.m6w6.name Git - awesomized/libmemcached/blob - docs/memcached_create.rst

   1 ======================================
   2 Creating and destroying a memcached_st
   3 ======================================
   4
   5
   6 Create a memcached_st structure
   7
   8
   9 *******
  10 LIBRARY
  11 *******
  12
  13
  14 C Client Library for memcached (libmemcached, -lmemcached)
  15
  16
  17 --------
  18 SYNOPSIS
  19 --------
  20
  21
  22
  23 .. code-block:: perl
  24
  25    #include <libmemcached/memcached.h>
  26
  27    memcached_st *memcached_create (memcached_st *ptr);
  28
  29    void memcached_free (memcached_st *ptr);
  30
  31    memcached_st *memcached_clone (memcached_st *destination, memcached_st *source);
  32
  33    void memcached_servers_reset(memcached_st);
  34
  35
  36
  37 -----------
  38 DESCRIPTION
  39 -----------
  40
  41
  42 memcached_create() is used to create a \ ``memcached_st``\  structure that will then
  43 be used by other libmemcached(3) functions to communicate with the server. You
  44 should either pass a statically declared \ ``memcached_st``\  to memcached_create() or
  45 a NULL. If a NULL passed in then a structure is allocated for you.
  46
  47 memcached_clone() is similar to memcached_create(3) but it copies the
  48 defaults and list of servers from the source \ ``memcached_st``\ . If you pass a null as
  49 the argument for the source to clone, it is the same as a call to memcached_create().
  50 If the destination argument is NULL a \ ``memcached_st``\  will be allocated for you.
  51
  52 memcached_servers_reset() allows you to zero out the list of servers that
  53 the memcached_st has.
  54
  55 To clean up memory associated with a \ ``memcached_st``\  structure you should pass
  56 it to memcached_free() when you are finished using it. memcached_free() is
  57 the only way to make sure all memory is deallocated when you finish using
  58 the structure.
  59
  60 You may wish to avoid using memcached_create(3) or memcached_clone(3) with a
  61 stack based allocation. The most common issues related to ABI safety involve
  62 heap allocated structures.
  63
  64
  65 ******
  66 RETURN
  67 ******
  68
  69
  70 memcached_create() returns a pointer to the memcached_st that was created
  71 (or initialized). On an allocation failure, it returns NULL.
  72
  73 memcached_clone() returns a pointer to the memcached_st that was created
  74 (or initialized). On an allocation failure, it returns NULL.
  75
  76
  77 ****
  78 HOME
  79 ****
  80
  81
  82 To find out more information please check:
  83 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
  84
  85
  86 ******
  87 AUTHOR
  88 ******
  89
  90
  91 Brian Aker, <brian@tangent.org>
  92
  93
  94 --------
  95 SEE ALSO
  96 --------
  97
  98
  99 :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`