projects
/
awesomized
/
libmemcached
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
|
github
raw
|
inline
| side by side
testing: limit random port range to probably unused ports
[awesomized/libmemcached]
/
docs
/
source
/
libmemcached
/
memcached_flush.rst
diff --git
a/docs/source/libmemcached/memcached_flush.rst
b/docs/source/libmemcached/memcached_flush.rst
index 071a989ff1fe2608b50ddbdafb0179ac9d67f738..342ee1f5c86bd69bfb91913f91c017b9ff76f1e2 100644
(file)
--- a/
docs/source/libmemcached/memcached_flush.rst
+++ b/
docs/source/libmemcached/memcached_flush.rst
@@
-1,39
+1,46
@@
Wiping clean the contents of a server
=====================================
Wiping clean the contents of a server
=====================================
-.. index:: object: memcached_st
-
-Wipe contents of memcached servers
-
SYNOPSIS
--------
#include <libmemcached/memcached.h>
SYNOPSIS
--------
#include <libmemcached/memcached.h>
+ Compile and link with -lmemcached
.. function:: memcached_return_t memcached_flush (memcached_st *ptr, time_t expiration)
.. function:: memcached_return_t memcached_flush (memcached_st *ptr, time_t expiration)
-Compile and link with -lmemcached
+ :param ptr: pointer to an initialized `memcached_st` struct
+ :param expiration: expiration as a unix timestamp or as relative expiration time in seconds
+ :returns: `memcached_return_t` indicating success
DESCRIPTION
-----------
DESCRIPTION
-----------
-
:func::`memcached_flush` is used to wipe clean the contents of :program:`memcached
` servers.
+
`memcached_flush` is used to wipe clean the contents of :manpage:`memcached(1)
` 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
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.
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
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
-------
+RETURN
VALUE
+------
------
-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`.
On success that value will be `MEMCACHED_SUCCESS`.
-Use
:type:
`memcached_strerror` to translate this value to a printable string.
+Use `memcached_strerror` to translate this value to a printable string.
SEE ALSO
--------
.. only:: man
SEE ALSO
--------
.. only:: man
- :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+ :manpage:`memcached(1)`
+ :manpage:`libmemcached(3)`
+ :manpage:`memcached_strerror(3)`
+
+.. only:: html
+
+ * :manpage:`memcached(1)`
+ * :doc:`../libmemcached`
+ * :doc:`memcached_strerror`