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

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