Fixed autoconf macros for cross compile
[awesomized/libmemcached] / docs / memcached_dump.pod
1 =head1 NAME
2
3 memcached_dump - get a list of keys found on memcached servers
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_t
14 memcached_dump (memcached_st *ptr,
15 memcached_dump_fn *function,
16 void *context,
17 uint32_t number_of_callbacks);
18
19 typedef memcached_return_t (*memcached_dump_fn)(memcached_st *ptr,
20 const char *key,
21 size_t key_length,
22 void *context);
23
24 =head1 DESCRIPTION
25
26 memcached_dump() is used to get a list of keys found memcached(1) servers.
27 Because memcached(1) does not guarentee to dump all keys you can not assume
28 you have fetched all keys from the server. The function takes an array
29 of callbacks that it will use to execute on keys as they are found.
30
31 Currently the binar protocol is not supported.
32
33 =head1 RETURN
34
35 A value of type C<memcached_return_t> is returned
36 On success that value will be C<MEMCACHED_SUCCESS>.
37 Use memcached_strerror() to translate this value to a printable string.
38
39 =head1 HOME
40
41 To find out more information please check:
42 L<https://launchpad.net/libmemcached>
43
44 =head1 AUTHOR
45
46 Brian Aker, E<lt>brian@tangent.orgE<gt>
47
48 =head1 SEE ALSO
49
50 memcached(1) libmemcached(3) memcached_strerror(3)
51
52 =cut
53