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

   1 ======================================
   2 Creating and destroying a memcached_st
   3 ======================================
   4
   5 --------
   6 SYNOPSIS
   7 --------
   8
   9 #include <libmemcached/memcached.h>
  10
  11 .. type:: memcached_st
  12
  13 .. function:: memcached_st* memcached_create(memcached_st *ptr)
  14
  15 .. function:: void memcached_free(memcached_st *ptr)
  16
  17 .. function:: memcached_st* memcached_clone(memcached_st *destination, memcached_st *source)
  18
  19 .. function:: void memcached_servers_reset(memcached_st)
  20
  21 Compile and link with -lmemcached
  22
  23 -----------
  24 DESCRIPTION
  25 -----------
  26
  27 :func:`memcached_create` is used to create a :type:`memcached_st`
  28 structure that will then be used by other libmemcached(3) functions to
  29 communicate with the server. You should either pass a statically declared
  30 :type:`memcached_st` to :func:`memcached_create` or
  31 a NULL. If a NULL passed in then a structure is allocated for you.
  32
  33 Please note, when you write new application use
  34 :func:`memcached` over :func:`memcached_create`.
  35
  36 :func:`memcached_clone` is similar to :func:`memcached_create` but
  37 it copies the defaults and list of servers from the source
  38 :type:`memcached_st`. If you pass a null as the argument for the source
  39 to clone, it is the same as a call to :func:`memcached_create`.
  40 If the destination argument is NULL a :type:`memcached_st` will be allocated
  41 for you.
  42
  43 :func:`memcached_servers_reset` allows you to zero out the list of
  44 servers that the :type:`memcached_st` has.
  45
  46 To clean up memory associated with a :type:`memcached_st` structure you
  47 should pass it to :func:`memcached_free` when you are finished using it.
  48 :func:`memcached_free` is the only way to make sure all memory is
  49 deallocated when you finish using the structure.
  50
  51 You may wish to avoid using memcached_create(3) or memcached_clone(3) with a
  52 stack based allocation. The most common issues related to ABI safety involve
  53 heap allocated structures.
  54
  55 ------
  56 RETURN
  57 ------
  58
  59 :func:`memcached_create` returns a pointer to the :type:`memcached_st`
  60 that was created (or initialized). On an allocation failure, it returns NULL.
  61
  62 :func:`memcached_clone` returns a pointer to the :type:`memcached_st`
  63 that was created (or initialized). On an allocation failure, it returns NULL.
  64
  65 --------
  66 SEE ALSO
  67 --------
  68
  69 .. only:: man
  70
  71   :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`