.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "MEMCACHED_FLUSH" "3" "Feb 01, 2024" "1.1" "libmemcached-awesome"
.SH NAME
memcached_flush \- libmemcached Documentation
.SH SYNOPSIS
.INDENT 0.0
.TP
.B #include <libmemcached/memcached.h>
Compile and link with \-lmemcached
.UNINDENT
.INDENT 0.0
.TP
.B \fI\%memcached_return_t\fP memcached_flush(\fI\%memcached_st\fP *ptr, time_t expiration) 
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBptr\fP \-\- pointer to an initialized \fI\%memcached_st\fP struct
.IP \(bu 2
\fBexpiration\fP \-\- expiration as a unix timestamp or as relative expiration time in seconds
.UNINDENT
.TP
.B Returns
\fI\%memcached_return_t\fP indicating success
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
\fI\%memcached_flush()\fP is used to wipe clean the contents of \fBmemcached(1)\fP servers.
It will either do this immediately or expire the content based on the
expiration time passed to the method (a value of zero causes an immediate
flush). The operation is not atomic to multiple servers, just atomic to a
single server. That is, it will flush the servers in the order that they were
added.
.SH RETURN VALUE
.sp
A value of type \fI\%memcached_return_t\fP is returned.
On success that value will be \fI\%MEMCACHED_SUCCESS\fP\&.
Use \fI\%memcached_strerror()\fP to translate this value to a printable string.
.SH SEE ALSO
.sp
\fBmemcached(1)\fP
\fBlibmemcached(3)\fP
\fBmemcached_strerror(3)\fP
.\" Generated by docutils manpage writer.
.