X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_flush_buffers.rst;h=888c9254420ed6d1072d4a3faa095e9e87311229;hb=dbc62573e1a6dc8cbcc97d0898e8615b0916d6ab;hp=e2067c157724a2fa3d54831f0e5e92a71e08959e;hpb=f285e1b3821f56a8983b5ce9fb1a0070e7bb0a1c;p=awesomized%2Flibmemcached diff --git a/docs/memcached_flush_buffers.rst b/docs/memcached_flush_buffers.rst index e2067c15..888c9254 100644 --- a/docs/memcached_flush_buffers.rst +++ b/docs/memcached_flush_buffers.rst @@ -1,77 +1,65 @@ -.. highlight:: perl +======================= +Flushing client buffers +======================= -memcached_flush_buffers -*********************** +.. index:: object: memcached_st +Flush and senf buffered commands -Flush buffers and send buffered commands - - -******* -LIBRARY -******* - - -C Client Library for memcached (libmemcached, -lmemcached) - - -******** +-------- SYNOPSIS -******** +-------- - - -.. code-block:: perl - - #include +#include - memcached_return_t - memcached_flush_buffers (memcached_st *ptr); +.. c:function:: memcached_return_t memcached_flush_buffers (memcached_st *ptr) +Compile and link with -lmemcached -*********** +----------- DESCRIPTION -*********** +----------- -memcached_flush_buffers() is used in conjunction with -MEMCACHED_BEHAVIOR_BUFFER_REQUESTS (see memcached_behavior(3)) to flush -all buffers by sending the buffered commands to the server for processing. +: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 \ ``memcached_return_t``\ is returned -On success that value will be \ ``MEMCACHED_SUCCESS``\ . -Use memcached_strerror() to translate this value to a printable string. +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: -`https://launchpad.net/libmemcached `_ +`http://libmemcached.org/ `_ -****** +------ AUTHOR -****** +------ +Brian Aker, + Trond Norbye, -******** +-------- SEE ALSO -******** - +-------- -memcached(1) libmemcached(3) memcached_strerror(3) memcached_behavior(3) +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`