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