docs: sanitize
[awesomized/libmemcached] / docs / source / libmemcached / memcached_flush_buffers.rst
1 Flushing client buffers
2 =======================
3
4 .. index:: object: memcached_st
5
6 Flush and send buffered commands
7
8 SYNOPSIS
9 --------
10
11 #include <libmemcached/memcached.h>
12
13 .. function:: memcached_return_t memcached_flush_buffers (memcached_st *ptr)
14
15 Compile and link with -lmemcached
16
17 DESCRIPTION
18 -----------
19
20 :func:`memcached_flush_buffers` is used in conjunction with
21 `MEMCACHED_BEHAVIOR_BUFFER_REQUESTS` (see memcached_behavior(3)) to flush all buffers by sending the buffered commands to the server for processing.
22
23 RETURN VALUE
24 ------------
25
26 A value of type :type:`memcached_return_t` is returned
27 On success that value will be `MEMCACHED_SUCCESS`.
28 Use :func:`memcached_strerror` to translate this value to a printable
29 string.
30
31 SEE ALSO
32 --------
33
34 .. only:: man
35
36 :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`