X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fsource%2Flibmemcached%2Fmemcached_flush_buffers.rst;h=9e71fb2110d2fc17818ccf6dd4b91d8584c88048;hb=e20117720ca0fa133781b62c43aab59fe864b390;hp=d94fa65d4feb09e49b23acb3e613c68284d4a5f1;hpb=28c4d79e109e11d7d2a9f3189de57da28302ec68;p=m6w6%2Flibmemcached diff --git a/docs/source/libmemcached/memcached_flush_buffers.rst b/docs/source/libmemcached/memcached_flush_buffers.rst index d94fa65d..9e71fb21 100644 --- a/docs/source/libmemcached/memcached_flush_buffers.rst +++ b/docs/source/libmemcached/memcached_flush_buffers.rst @@ -1,46 +1,33 @@ -======================= Flushing client buffers ======================= - .. index:: object: memcached_st Flush and send buffered commands --------- SYNOPSIS -------- #include - + .. function:: memcached_return_t memcached_flush_buffers (memcached_st *ptr) Compile and link with -lmemcached - ------------ DESCRIPTION ----------- - -:func:`memcached_flush_buffers` is used in conjunction with +:func:`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. - ------- -RETURN ------- - +RETURN VALUE +------------ A value of type :type:`memcached_return_t` is returned On success that value will be `MEMCACHED_SUCCESS`. Use :func:`memcached_strerror` to translate this value to a printable string. - - - --------- SEE ALSO --------