.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "MEMCACHED_DUMP" "3" "Mar 11, 2024" "1.1" "libmemcached-awesome"
.SH NAME
memcached_dump \- libmemcached Documentation
.SH SYNOPSIS
.INDENT 0.0
.TP
.B #include <libmemcached/memcached.h>
Compile and link with \-lmemcached
.UNINDENT
.INDENT 0.0
.TP
.B typedef \fI\%memcached_return_t\fP (*memcached_dump_fn)(\fI\%memcached_st\fP *ptr, const char *key, size_t key_length, void *context) 
.INDENT 7.0
.TP
.B Param ptr
pointer to \fI\%memcached_st\fP object
.TP
.B Param key
key string being dumped
.TP
.B Param key_length
length of the key without any terminating zero
.TP
.B Param context
pointer to the user supplied context
.TP
.B Returns
\fI\%memcached_return_t\fP indicating success
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \fI\%memcached_return_t\fP memcached_dump(\fI\%memcached_st\fP *ptr, \fI\%memcached_dump_fn\fP *function, void *context, uint32_t number_of_callbacks) 
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBptr\fP \-\- pointer to initialized \fI\%memcached_st\fP struct
.IP \(bu 2
\fBfunction\fP \-\- pointer to \fI\%number_of_callbacks\fP \fI\%memcached_dump_fn\fP callbacks
.IP \(bu 2
\fBcontext\fP \-\- pointer to a user managed context
.IP \(bu 2
\fBnumber_of_callbacks\fP \-\- number of callbacks in the \fI\%function\fP array
.UNINDENT
.TP
.B Returns
\fI\%memcached_return_t\fP indicating success
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
\fI\%memcached_dump()\fP is used to get a list of keys found in \fBmemcached(1)\fP
servers. Because memcached does not guarantee to dump all keys you can not
assume you have fetched all keys from the server. The function takes an array
of callbacks that it will use to execute on keys as they are found.
.sp
Currently the binary protocol is not tested.
.SH RETURN VALUE
.sp
A value of type \fI\%memcached_return_t\fP is returned.
On success that value will be \fI\%MEMCACHED_SUCCESS\fP\&.
Use \fI\%memcached_strerror()\fP to translate this value to a printable
string.
.SH SEE ALSO
.sp
\fBmemcached(1)\fP
\fBlibmemcached(3)\fP
\fBmemcached_strerror(3)\fP
.\" Generated by docutils manpage writer.
.