← Back to branch summary

~brianaker/libmemcached/1164440

« back to all changes in this revision

Viewing changes to docs/memcached_flush.pod

Merging bzr://gaz.tangent.org/libmemcached/build/ to Build branch

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/memcached_flush.pod
1
 
=head1 NAME
2
 
 
3
 
memcached_flush
4
 
 
5
 
=head1 LIBRARY
6
 
 
7
 
C Client Library for memcached (libmemcached, -lmemcached)
8
 
 
9
 
=head1 SYNOPSIS
10
 
 
11
 
  #include <memcached.h>
12
 
 
13
 
  memcached_return
14
 
    memcached_flush (memcached_st *ptr,
15
 
                     time_t expiration);
16
 
 
17
 
=head1 DESCRIPTION
18
 
 
19
 
memcached_flush() is used to wipe clean the contents of memcached(1) servers.
20
 
It will either do this immediately or expire the content based on the
21
 
expiration time passed to the method (a value of zero causes an immediate
22
 
flush). The operation is not atomic to multiple servers, just atomic to a
23
 
single server. That is, it will flush the servers in the order that they were
24
 
added.
25
 
 
26
 
=head1 RETURN
27
 
 
28
 
A value of type C<memcached_return> is returned
29
 
On success that value will be C<MEMCACHED_SUCCESS>.
30
 
Use memcached_strerror() to translate this value to a printable string.
31
 
 
32
 
=head1 HOME
33
 
 
34
 
To find out more information please check:
35
 
L<http://tangent.org/552/libmemcached.html>
36
 
 
37
 
=head1 AUTHOR
38
 
 
39
 
Brian Aker, E<lt>brian@tangent.orgE<gt>
40
 
 
41
 
=head1 SEE ALSO
42
 
 
43
 
memcached(1) libmemcached(3) memcached_strerror(3)
44
 
 
45
 
=cut
46