Update to include build info.
[m6w6/libmemcached] / docs / man / memcached_flush_buffers.3
1 .TH "MEMCACHED_FLUSH_BUFFERS" "3" "August 02, 2012" "1.0.10" "libmemcached"
2 .SH NAME
3 memcached_flush_buffers \- 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 Flush and senf buffered commands
35 .SH SYNOPSIS
36 .sp
37 #include <libmemcached/memcached.h>
38 .INDENT 0.0
39 .TP
40 .B memcached_return_t memcached_flush_buffers(memcached_st\fI\ *ptr\fP)
41 .UNINDENT
42 .sp
43 Compile and link with \-lmemcached
44 .SH DESCRIPTION
45 .sp
46 \fI\%memcached_flush_buffers()\fP is used in conjunction with
47 \fBMEMCACHED_BEHAVIOR_BUFFER_REQUESTS\fP (see memcached_behavior(3)) to flush all buffers by sending the buffered commands to the server for processing.
48 .SH RETURN
49 .sp
50 A value of type \fBmemcached_return_t\fP is returned
51 On success that value will be \fBMEMCACHED_SUCCESS\fP.
52 Use \fBmemcached_strerror()\fP to translate this value to a printable
53 string.
54 .SH HOME
55 .sp
56 To find out more information please check:
57 \fI\%http://libmemcached.org/\fP
58 .SH AUTHOR
59 .sp
60 Brian Aker, <\fI\%brian@tangent.org\fP>
61 .sp
62 Trond Norbye, <\fI\%trond.norbye@gmail.com\fP>
63 .SH SEE ALSO
64 .sp
65 \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
66 .SH AUTHOR
67 Brian Aker
68 .SH COPYRIGHT
69 2011, Brian Aker DataDifferential, http://datadifferential.com/
70 .\" Generated by docutils manpage writer.
71 .\"
72 .