Merged trunk.
[awesomized/libmemcached] / docs / memcached_flush_buffers.rst
1 .. highlight:: perl
2
3
4 ****
5 NAME
6 ****
7
8
9 memcached_flush_buffers - Flush buffers and send buffered commands
10
11
12 *******
13 LIBRARY
14 *******
15
16
17 C Client Library for memcached (libmemcached, -lmemcached)
18
19
20 ********
21 SYNOPSIS
22 ********
23
24
25
26 .. code-block:: perl
27
28 #include <memcached.h>
29
30 memcached_return_t
31 memcached_flush_buffers (memcached_st *ptr);
32
33
34
35 ***********
36 DESCRIPTION
37 ***********
38
39
40 memcached_flush_buffers() is used in conjunction with
41 MEMCACHED_BEHAVIOR_BUFFER_REQUESTS (see memcached_behavior(3)) to flush
42 all buffers by sending the buffered commands to the server for processing.
43
44
45 ******
46 RETURN
47 ******
48
49
50 A value of type \ ``memcached_return_t``\ is returned
51 On success that value will be \ ``MEMCACHED_SUCCESS``\ .
52 Use memcached_strerror() to translate this value to a printable string.
53
54
55 ****
56 HOME
57 ****
58
59
60 To find out more information please check:
61 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
62
63
64 ******
65 AUTHOR
66 ******
67
68
69 Trond Norbye, <trond.norbye@gmail.com>
70
71
72 ********
73 SEE ALSO
74 ********
75
76
77 memcached(1) libmemcached(3) memcached_strerror(3) memcached_behavior(3)
78