Merge in code for C++ compiling of libmemcached.
[awesomized/libmemcached] / docs / man / memcached_analyze.3
1 .TH "MEMCACHED_ANALYZE" "3" "April 14, 2011" "0.47" "libmemcached"
2 .SH NAME
3 memcached_analyze \- 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 Analyze server information
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_analysis_st *
45 memcached_analyze (memcached_st *ptr,
46 memcached_stat_st *stat,
47 memcached_return_t *error);
48 .ft P
49 .fi
50 .SH DESCRIPTION
51 .sp
52 libmemcached(3) has the ability to query a memcached server (or collection
53 of servers) for their current state. Queries to find state return a
54 \fBmemcached_analysis_st\fP structure. You are responsible for freeing this structure.
55 .sp
56 memcached_analyze() analyzes useful information based on the provided servers
57 and sets the result to the \fBmemcached_analysis_st\fP structure. The return value
58 must be freed by the calling application.
59 .sp
60 A command line tool, memstat(1) with the option \-\-analyze, is provided so that
61 you do not have to write an application to use this method.
62 .SH RETURN
63 .sp
64 A pointer to the allocated \fBmemcached_analysis_st\fP structure on success and
65 a NULL pointer on failure. You may inspect the error detail by checking the
66 \fBmemcached_return_t\fP value.
67 .sp
68 Any method returning a \fBmemcached_analysis_st\fP expects you to free the
69 memory allocated for it.
70 .SH HOME
71 .sp
72 To find out more information please check:
73 \fI\%http://libmemcached.org/\fP
74 .SH SEE ALSO
75 .sp
76 \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
77 .SH AUTHOR
78 Brian Aker
79 .SH COPYRIGHT
80 2011, Brian Aker DataDifferential, http://datadifferential.com/
81 .\" Generated by docutils manpage writer.
82 .\"
83 .