From f2a59b728c20f7fe78874dd41187ab3fb2db6c7e Mon Sep 17 00:00:00 2001 From: Brian Aker Date: Sun, 16 Feb 2014 01:06:40 -0800 Subject: Fix for building docs. --- docs/source/memcached_flush_buffers.rst | 65 +++++++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 docs/source/memcached_flush_buffers.rst (limited to 'docs/source/memcached_flush_buffers.rst') diff --git a/docs/source/memcached_flush_buffers.rst b/docs/source/memcached_flush_buffers.rst new file mode 100644 index 00000000..888c9254 --- /dev/null +++ b/docs/source/memcached_flush_buffers.rst @@ -0,0 +1,65 @@ +======================= +Flushing client buffers +======================= + + +.. index:: object: memcached_st + +Flush and senf buffered commands + +-------- +SYNOPSIS +-------- + +#include + +.. c:function:: memcached_return_t memcached_flush_buffers (memcached_st *ptr) + +Compile and link with -lmemcached + + +----------- +DESCRIPTION +----------- + + +:c:func:`memcached_flush_buffers` is used in conjunction with +:c:type:`MEMCACHED_BEHAVIOR_BUFFER_REQUESTS` (see memcached_behavior(3)) to flush all buffers by sending the buffered commands to the server for processing. + + +------ +RETURN +------ + + +A value of type :c:type:`memcached_return_t` is returned +On success that value will be :c:type:`MEMCACHED_SUCCESS`. +Use :c:func:`memcached_strerror` to translate this value to a printable +string. + + +---- +HOME +---- + + +To find out more information please check: +`http://libmemcached.org/ `_ + + +------ +AUTHOR +------ + + +Brian Aker, + +Trond Norbye, + + +-------- +SEE ALSO +-------- + + +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` -- cgit v1.2.1