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