Merge from trunk.
[awesomized/libmemcached] / docs / memcached_flush_buffers.pod
1 =head1 NAME
2
3 memcached_flush_buffers - Flush buffers and send buffered commands
4
5 =head1 LIBRARY
6
7 C Client Library for memcached (libmemcached, -lmemcached)
8
9 =head1 SYNOPSIS
10
11 #include <memcached.h>
12
13 memcached_return
14 memcached_flush_buffers (memcached_st *ptr);
15
16 =head1 DESCRIPTION
17
18 memcached_flush_buffers() is used in conjunction with
19 MEMCACHED_BEHAVIOR_BUFFER_REQUESTS (see memcached_behavior(3)) to flush
20 all buffers by sending the buffered commands to the server for processing..
21
22 =head1 RETURN
23
24 A value of type C<memcached_return> is returned
25 On success that value will be C<MEMCACHED_SUCCESS>.
26 Use memcached_strerror() to translate this value to a printable string.
27
28 =head1 HOME
29
30 To find out more information please check:
31 L<http://tangent.org/552/libmemcached.html>
32
33 =head1 AUTHOR
34
35 Trond Norbye, E<lt>trond.norbye@sun.comE<gt>
36
37 =head1 SEE ALSO
38
39 memcached(1) libmemcached(3) memcached_strerror(3) memcached_behavior(3)
40
41 =cut
42