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

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