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