Update for release 1.01
[awesomized/libmemcached] / docs / man / memcached_dump.3
1 .TH "MEMCACHED_DUMP" "3" "October 24, 2011" "1.01" "libmemcached"
2 .SH NAME
3 memcached_dump \- libmemcached Documentation
4 .
5 .nr rst2man-indent-level 0
6 .
7 .de1 rstReportMargin
8 \\$1 \\n[an-margin]
9 level \\n[rst2man-indent-level]
10 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
11 -
12 \\n[rst2man-indent0]
13 \\n[rst2man-indent1]
14 \\n[rst2man-indent2]
15 ..
16 .de1 INDENT
17 .\" .rstReportMargin pre:
18 . RS \\$1
19 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
20 . nr rst2man-indent-level +1
21 .\" .rstReportMargin post:
22 ..
23 .de UNINDENT
24 . RE
25 .\" indent \\n[an-margin]
26 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
27 .nr rst2man-indent-level -1
28 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
29 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
30 ..
31 .\" Man page generated from reStructeredText.
32 .
33 .sp
34 Get a list of keys found on memcached servers
35 .SH SYNOPSIS
36 .sp
37 #include <libmemcached/memcached.h>
38 .INDENT 0.0
39 .TP
40 .B memcached_return_t memcached_dump (memcached_st *ptr, memcached_dump_fn *function, void *context, uint32_t number_of_callbacks);
41 .UNINDENT
42 .INDENT 0.0
43 .TP
44 .B typedef memcached_return_t (*memcached_dump_fn)(memcached_st *ptr, const char *key, size_t key_length, void *context);
45 .UNINDENT
46 .sp
47 Compile and link with \-lmemcached
48 .SH DESCRIPTION
49 .sp
50 \fBmemcached_dump()\fP is used to get a list of keys found in memcached(1)
51 servers. Because memcached(1) does not guarentee to dump all keys you can not
52 assume you have fetched all keys from the server. The function takes an array
53 of callbacks that it will use to execute on keys as they are found.
54 .sp
55 Currently the binary protocol is not testsed.
56 .SH RETURN
57 .sp
58 A value of type \fBmemcached_return_t\fP is returned
59 On success that value will be \fBMEMCACHED_SUCCESS\fP.
60 Use \fBmemcached_strerror()\fP to translate this value to a printable
61 string.
62 .SH HOME
63 .sp
64 To find out more information please check:
65 \fI\%http://libmemcached.org/\fP
66 .SH AUTHOR
67 .sp
68 Brian Aker, <\fI\%brian@tangent.org\fP>
69 .SH SEE ALSO
70 .sp
71 \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
72 .SH AUTHOR
73 Brian Aker
74 .SH COPYRIGHT
75 2011, Brian Aker DataDifferential, http://datadifferential.com/
76 .\" Generated by docutils manpage writer.
77 .\"
78 .