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

   1 .. highlight:: perl
   2
   3
   4 memcached_flush
   5 ***************
   6
   7
   8 Wipe contents of memcached servers
   9
  10
  11 *******
  12 LIBRARY
  13 *******
  14
  15
  16 C Client Library for memcached (libmemcached, -lmemcached)
  17
  18
  19 ********
  20 SYNOPSIS
  21 ********
  22
  23
  24
  25 .. code-block:: perl
  26
  27    #include <libmemcached/memcached.h>
  28
  29    memcached_return_t
  30      memcached_flush (memcached_st *ptr,
  31                       time_t expiration);
  32
  33
  34
  35 ***********
  36 DESCRIPTION
  37 ***********
  38
  39
  40 memcached_flush() is used to wipe clean the contents of memcached(1) servers.
  41 It will either do this immediately or expire the content based on the
  42 expiration time passed to the method (a value of zero causes an immediate
  43 flush). The operation is not atomic to multiple servers, just atomic to a
  44 single server. That is, it will flush the servers in the order that they were
  45 added.
  46
  47
  48 ******
  49 RETURN
  50 ******
  51
  52
  53 A value of type \ ``memcached_return_t``\  is returned
  54 On success that value will be \ ``MEMCACHED_SUCCESS``\ .
  55 Use memcached_strerror() to translate this value to a printable string.
  56
  57
  58 ****
  59 HOME
  60 ****
  61
  62
  63 To find out more information please check:
  64 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
  65
  66
  67 ******
  68 AUTHOR
  69 ******
  70
  71
  72 Brian Aker, <brian@tangent.org>
  73
  74
  75 ********
  76 SEE ALSO
  77 ********
  78
  79 :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`