Style cleanup
[m6w6/libmemcached] / docs / memcached_flush_buffers.rst
1 =======================
2 Flushing client buffers
3 =======================
4
5
6 .. index:: object: memcached_st
7
8 Flush and senf buffered commands
9
10 --------
11 SYNOPSIS
12 --------
13
14 #include <libmemcached/memcached.h>
15
16 .. c:function:: memcached_return_t memcached_flush_buffers (memcached_st *ptr);
17
18 Compile and link with -lmemcached
19
20
21 -----------
22 DESCRIPTION
23 -----------
24
25
26 :c:func:`memcached_flush_buffers()` is used in conjunction with
27 :c:type:`MEMCACHED_BEHAVIOR_BUFFER_REQUESTS` (see memcached_behavior(3)) to flush all buffers by sending the buffered commands to the server for processing.
28
29
30 ------
31 RETURN
32 ------
33
34
35 A value of type :c:type:`memcached_return_t` is returned
36 On success that value will be :c:type:`MEMCACHED_SUCCESS`.
37 Use :c:func:`memcached_strerror()` to translate this value to a printable
38 string.
39
40
41 ----
42 HOME
43 ----
44
45
46 To find out more information please check:
47 `http://libmemcached.org/ <http://libmemcached.org/>`_
48
49
50 ------
51 AUTHOR
52 ------
53
54
55 Brian Aker, <brian@tangent.org>
56
57 Trond Norbye, <trond.norbye@gmail.com>
58
59
60 --------
61 SEE ALSO
62 --------
63
64
65 :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`