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

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