Merge pull request #140 from hussainnaqvee/patch-1
[awesomized/libmemcached] / libmemcached / memcached_flush_buffers.rst
1 Flush and send buffered commands
2 ================================
3
4 SYNOPSIS
5 --------
6
7 #include <libmemcached/memcached.h>
8 Compile and link with -lmemcached
9
10 .. function:: memcached_return_t memcached_flush_buffers (memcached_st *ptr)
11
12 :param ptr: pointer to initialized `memcached_st` struct
13 :returns: `memcached_return_t` indicating success
14
15 DESCRIPTION
16 -----------
17
18 :func:`memcached_flush_buffers` is used in conjunction with
19 `MEMCACHED_BEHAVIOR_BUFFER_REQUESTS` to flush all buffers by
20 sending the buffered commands to the server for processing.
21
22 RETURN VALUE
23 ------------
24
25 A value of type :type:`memcached_return_t` is returned.
26 On success that value will be `MEMCACHED_SUCCESS`.
27 Use :func:`memcached_strerror` to translate this value to a printable string.
28
29 SEE ALSO
30 --------
31
32 .. only:: man
33
34 :manpage:`memcached(1)`
35 :manpage:`libmemcached(3)`
36 :manpage:`memcached_strerror(3)`
37 :manpage:`memcached_behavior(3)`
38
39 .. only:: html
40
41 * :manpage:`memcached(1)`
42 * :doc:`../libmemcached`
43 * :doc:`memcached_strerror`
44 * :doc:`memcached_behavior`