.\" 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_ANALYZE" "3" "Mar 11, 2024" "1.1" "libmemcached-awesome"
.SH NAME
memcached_analyze \- 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 struct \fI\%memcached_analysis_st\fP memcached_analysis_st 
.UNINDENT
.INDENT 0.0
.TP
.B \fI\%memcached_analysis_st\fP *memcached_analyze(\fI\%memcached_st\fP *ptr, \fI\%memcached_stat_st\fP *stat, \fI\%memcached_return_t\fP *error) 
.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
\fBstat\fP \-\- pointer to a \fI\%memcached_stat_st\fP struct to fill
.IP \(bu 2
\fBerror\fP \-\- pointer to \fI\%memcached_return_t\fP indicating success
.UNINDENT
.TP
.B Returns
pointer to an allocated and filled out \fBmemcached_analysis_t\fP struct
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
\fBlibmemcached\fP has the ability to query a memcached server (or collection of
servers) for their current state. Queries to find state return a
\fI\%memcached_analysis_st\fP structure. You are responsible for freeing this
structure.
.sp
\fI\%memcached_analyze()\fP analyzes useful information based on the provided servers
and sets the result to the \fI\%memcached_analysis_st\fP structure. The return value
must be freed by the calling application.
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fBmemstat \-a|\-\-analyze [<arg>]\fP
A command line tool to analyze a memcached server.
.UNINDENT
.UNINDENT
.SH RETURN VALUE
.sp
A pointer to the allocated \fI\%memcached_analysis_st\fP structure on success and a
NULL pointer on failure. You may inspect the error detail by checking the
\fI\%memcached_return_t\fP value.
.sp
Any method returning a \fI\%memcached_analysis_st\fP expects you to free the memory
allocated for it.
.SH SEE ALSO
.sp
\fBmemcached(1)\fP
\fBlibmemcached(3)\fP
\fBmemcached_strerror(3)\fP
.\" Generated by docutils manpage writer.
.