Style cleanup
[m6w6/libmemcached] / docs / memcached_flush.rst
1 =====================================
2 Wiping clean the contents of a server
3 =====================================
4
5 .. index:: object: memcached_st
6
7 Wipe contents of memcached servers
8
9
10 --------
11 SYNOPSIS
12 --------
13
14
15 #include <libmemcached/memcached.h>
16
17 .. c:function:: memcached_return_t memcached_flush (memcached_st *ptr, time_t expiration);
18
19 Compile and link with -lmemcached
20
21
22 -----------
23 DESCRIPTION
24 -----------
25
26
27 :c:func::`memcached_flush()` is used to wipe clean the contents of :program:`memcached` servers.
28 It will either do this immediately or expire the content based on the
29 expiration time passed to the method (a value of zero causes an immediate
30 flush). The operation is not atomic to multiple servers, just atomic to a
31 single server. That is, it will flush the servers in the order that they were
32 added.
33
34
35 ------
36 RETURN
37 ------
38
39
40 A value of type :c:type:`memcached_return_t` is returned
41 On success that value will be :c:type:`MEMCACHED_SUCCESS`.
42 Use :c:type:`memcached_strerror()` to translate this value to a printable string.
43
44 ----
45 HOME
46 ----
47
48
49 To find out more information please check:
50 `http://libmemcached.org/ <http://libmemcached.org/>`_
51
52
53 ------
54 AUTHOR
55 ------
56
57
58 Brian Aker, <brian@tangent.org>
59
60
61 --------
62 SEE ALSO
63 --------
64
65 :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`