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

   1 .TH "MEMCACHED_FLUSH" "3" "October 18, 2011" "1.01" "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 Wipe contents of memcached servers
  35 .SH SYNOPSIS
  36 .sp
  37 #include <libmemcached/memcached.h>
  38 .INDENT 0.0
  39 .TP
  40 .B memcached_return_t memcached_flush (memcached_st *ptr, time_t expiration);
  41 .UNINDENT
  42 .sp
  43 Compile and link with \-lmemcached
  44 .SH DESCRIPTION
  45 .sp
  46 :c:func::\fImemcached_flush()\fP is used to wipe clean the contents of \fBmemcached\fP servers.
  47 It will either do this immediately or expire the content based on the
  48 expiration time passed to the method (a value of zero causes an immediate
  49 flush). The operation is not atomic to multiple servers, just atomic to a
  50 single server. That is, it will flush the servers in the order that they were
  51 added.
  52 .SH RETURN
  53 .sp
  54 A value of type \fBmemcached_return_t\fP is returned
  55 On success that value will be \fBMEMCACHED_SUCCESS\fP.
  56 Use \fBmemcached_strerror()\fP to translate this value to a printable string.
  57 .SH HOME
  58 .sp
  59 To find out more information please check:
  60 \fI\%http://libmemcached.org/\fP
  61 .SH AUTHOR
  62 .sp
  63 Brian Aker, <\fI\%brian@tangent.org\fP>
  64 .SH SEE ALSO
  65 .sp
  66 \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
  67 .SH AUTHOR
  68 Brian Aker
  69 .SH COPYRIGHT
  70 2011, Brian Aker DataDifferential, http://datadifferential.com/
  71 .\" Generated by docutils manpage writer.
  72 .\"
  73 .