X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fsource%2Flibmemcached%2Fmemcached_flush.rst;h=071a989ff1fe2608b50ddbdafb0179ac9d67f738;hb=43032f572a83233b5183ed6989921efe930aa719;hp=661d8e6a41b511a53c0773bd31d8e7ebce2a4328;hpb=28c4d79e109e11d7d2a9f3189de57da28302ec68;p=m6w6%2Flibmemcached diff --git a/docs/source/libmemcached/memcached_flush.rst b/docs/source/libmemcached/memcached_flush.rst index 661d8e6a..071a989f 100644 --- a/docs/source/libmemcached/memcached_flush.rst +++ b/docs/source/libmemcached/memcached_flush.rst @@ -1,4 +1,3 @@ -===================================== Wiping clean the contents of a server ===================================== @@ -6,24 +5,18 @@ Wiping clean the contents of a server Wipe contents of memcached servers - --------- SYNOPSIS -------- - #include - + .. function:: memcached_return_t memcached_flush (memcached_st *ptr, time_t expiration) Compile and link with -lmemcached - ------------ DESCRIPTION ----------- - :func::`memcached_flush` is used to wipe clean the contents of :program:`memcached` servers. It will either do this immediately or expire the content based on the expiration time passed to the method (a value of zero causes an immediate @@ -31,18 +24,13 @@ flush). The operation is not atomic to multiple servers, just atomic to a single server. That is, it will flush the servers in the order that they were added. - ------- RETURN ------ - -A value of type :type:`memcached_return_t` is returned +A value of type :type:`memcached_return_t` is returned On success that value will be `MEMCACHED_SUCCESS`. Use :type:`memcached_strerror` to translate this value to a printable string. - --------- SEE ALSO --------