← Back to branch summary

~piotr-sikora/libmemcached/fix-tests-on-openbsd

« back to all changes in this revision

Viewing changes to docs/man/memcached_dump.3

Merge in all of build.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/man/memcached_dump.3
 
1
.TH "MEMCACHED_DUMP" "3" "April 09, 2011" "0.47" "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 LIBRARY
 
36
.sp
 
37
C Client Library for memcached (libmemcached, \-lmemcached)
 
38
.SH SYNOPSIS
 
39
.sp
 
40
.nf
 
41
.ft C
 
42
#include <libmemcached/memcached.h>
 
43
 
 
44
memcached_return_t
 
45
  memcached_dump (memcached_st *ptr,
 
46
                  memcached_dump_fn *function,
 
47
                  void *context,
 
48
                  uint32_t number_of_callbacks);
 
49
 
 
50
typedef memcached_return_t (*memcached_dump_fn)(memcached_st *ptr,
 
51
                                                const char *key,
 
52
                                                size_t key_length,
 
53
                                                void *context);
 
54
.ft P
 
55
.fi
 
56
.SH DESCRIPTION
 
57
.sp
 
58
memcached_dump() is used to get a list of keys found  memcached(1) servers.
 
59
Because memcached(1) does not guarentee to dump all keys you can not assume
 
60
you have fetched all keys from the server. The function takes an array
 
61
of callbacks that it will use to execute on keys as they are found.
 
62
.sp
 
63
Currently the binar protocol is not testsed.
 
64
.SH RETURN
 
65
.sp
 
66
A value of type \fBmemcached_return_t\fP is returned
 
67
On success that value will be \fBMEMCACHED_SUCCESS\fP.
 
68
Use memcached_strerror() to translate this value to a printable string.
 
69
.SH HOME
 
70
.sp
 
71
To find out more information please check:
 
72
\fI\%https://launchpad.net/libmemcached\fP
 
73
.SH AUTHOR
 
74
.sp
 
75
Brian Aker, <\fI\%brian@tangent.org\fP>
 
76
.SH SEE ALSO
 
77
.sp
 
78
\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
 
79
.SH AUTHOR
 
80
Brian Aker
 
81
.SH COPYRIGHT
 
82
2011, Brian Aker DataDifferential, http://datadifferential.com/
 
83
.\" Generated by docutils manpage writer.
 
84
.\" 
 
85
.