git.m6w6.name Git - m6w6/libmemcached/blob - docs/man/memcached_flush.3

   1 .TH "MEMCACHED_FLUSH" "3" "April 08, 2011" "0.47" "libmemcached"
   2 .SH NAME
   3 memcached_flush \- libmemcached Documentation
   4 .
   5 .nr rst2man-indent-level 0
   6 .
   7 .de1 rstReportMargin
   8 \\$1 \\n[an-margin]
   9 level \\n[rst2man-indent-level]
  10 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  11 -
  12 \\n[rst2man-indent0]
  13 \\n[rst2man-indent1]
  14 \\n[rst2man-indent2]
  15 ..
  16 .de1 INDENT
  17 .\" .rstReportMargin pre:
  18 . RS \\$1
  19 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  20 . nr rst2man-indent-level +1
  21 .\" .rstReportMargin post:
  22 ..
  23 .de UNINDENT
  24 . RE
  25 .\" indent \\n[an-margin]
  26 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  27 .nr rst2man-indent-level -1
  28 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  29 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  30 ..
  31 .\" Man page generated from reStructeredText.
  32 .
  33 .sp
  34 memcached_flush
  35 \-\-\-\-\-\-\-\-\-\-\-\-\-\-*
  36 .sp
  37 Wipe contents of memcached servers
  38 .sp
  39 C Client Library for memcached (libmemcached, \-lmemcached)
  40 .SH SYNOPSIS
  41 .sp
  42 .nf
  43 .ft C
  44 #include <libmemcached/memcached.h>
  45
  46 memcached_return_t
  47   memcached_flush (memcached_st *ptr,
  48                    time_t expiration);
  49 .ft P
  50 .fi
  51 .SH DESCRIPTION
  52 .sp
  53 memcached_flush() is used to wipe clean the contents of memcached(1) servers.
  54 It will either do this immediately or expire the content based on the
  55 expiration time passed to the method (a value of zero causes an immediate
  56 flush). The operation is not atomic to multiple servers, just atomic to a
  57 single server. That is, it will flush the servers in the order that they were
  58 added.
  59 .sp
  60 A value of type \fBmemcached_return_t\fP is returned
  61 On success that value will be \fBMEMCACHED_SUCCESS\fP.
  62 Use memcached_strerror() to translate this value to a printable string.
  63 .sp
  64 To find out more information please check:
  65 \fI\%https://launchpad.net/libmemcached\fP
  66 .sp
  67 Brian Aker, <\fI\%brian@tangent.org\fP>
  68 .SH SEE ALSO
  69 .sp
  70 \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
  71 .SH AUTHOR
  72 Brian Aker
  73 .SH COPYRIGHT
  74 2011, Brian Aker
  75 .\" Generated by docutils manpage writer.
  76 .\"
  77 .