Merge in updates (including removal of some depcrated bits from the examples).
[awesomized/libmemcached] / docs / man / memcached_flush_buffers.3
1 .TH "MEMCACHED_FLUSH_BUFFERS" "3" "April 13, 2011" "0.47" "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 buffers and send buffered commands
35 .SH LIBRARY
36 .sp
37 C Client Library for memcached (libmemcached, \-lmemcached)
38 .SH SYNOPSIS
39 .sp
40 #include <libmemcached/memcached.h>
41 .INDENT 0.0
42 .TP
43 .B memcached_return_t memcached_flush_buffers (memcached_st *ptr);
44 .UNINDENT
45 .SH DESCRIPTION
46 .sp
47 memcached_flush_buffers() is used in conjunction with
48 MEMCACHED_BEHAVIOR_BUFFER_REQUESTS (see memcached_behavior(3)) to flush
49 all buffers by sending the buffered commands to the server for processing.
50 .SH RETURN
51 .sp
52 A value of type \fBmemcached_return_t\fP is returned
53 On success that value will be \fBMEMCACHED_SUCCESS\fP.
54 Use memcached_strerror() to translate this value to a printable string.
55 .SH HOME
56 .sp
57 To find out more information please check:
58 \fI\%http://libmemcached.org/\fP
59 .SH AUTHOR
60 .sp
61 Brian Aker, <\fI\%brian@tangent.org\fP>
62 .sp
63 Trond Norbye, <\fI\%trond.norbye@gmail.com\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 .