Deploy to GitHub pages
[awesomized/libmemcached] / libmemcached / memcached_analyze.html
1
2
3 <!DOCTYPE html>
4 <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
5 <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
6 <head>
7 <meta charset="utf-8">
8
9 <meta name="viewport" content="width=device-width, initial-scale=1.0">
10
11 <title>Analyzing servers &mdash; libmemcached 1.1.0 documentation</title>
12
13
14
15
16
17
18
19
20 <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
21
22
23 <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
24 <script type="text/javascript" src="../_static/jquery.js"></script>
25 <script type="text/javascript" src="../_static/underscore.js"></script>
26 <script type="text/javascript" src="../_static/doctools.js"></script>
27 <script type="text/javascript" src="../_static/language_data.js"></script>
28
29 <script type="text/javascript" src="../_static/js/theme.js"></script>
30
31
32
33
34 <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
35 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
36 <link rel="index" title="Index" href="../genindex.html" />
37 <link rel="search" title="Search" href="../search.html" />
38 <link rel="copyright" title="Copyright" href="../copyright.html" />
39 <link rel="next" title="Working with statistical information from a server" href="memcached_stats.html" />
40 <link rel="prev" title="Statistics" href="index_advanced_stats.html" />
41 </head>
42
43 <body class="wy-body-for-nav">
44
45
46 <div class="wy-grid-for-nav">
47
48 <nav data-toggle="wy-nav-shift" class="wy-nav-side">
49 <div class="wy-side-scroll">
50 <div class="wy-side-nav-search" >
51
52
53
54 <a href="../index.html" class="icon icon-home"> libmemcached
55
56
57
58 </a>
59
60
61
62
63 <div class="version">
64 1.1
65 </div>
66
67
68
69
70 <div role="search">
71 <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
72 <input type="text" name="q" placeholder="Search docs" />
73 <input type="hidden" name="check_keywords" value="yes" />
74 <input type="hidden" name="area" value="default" />
75 </form>
76 </div>
77
78
79 </div>
80
81 <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
82
83
84
85
86
87
88 <ul class="current">
89 <li class="toctree-l1"><a class="reference internal" href="../libmemcached.html">Introduction</a></li>
90 <li class="toctree-l1 current"><a class="reference internal" href="index.html">libmemcached API</a><ul class="current">
91 <li class="toctree-l2"><a class="reference internal" href="index_basics.html">Basics</a></li>
92 <li class="toctree-l2"><a class="reference internal" href="index_data.html">Working with Data</a></li>
93 <li class="toctree-l2"><a class="reference internal" href="index_errors.html">Messages and Errors</a></li>
94 <li class="toctree-l2 current"><a class="reference internal" href="index_advanced.html">Advanced Topics</a><ul class="current">
95 <li class="toctree-l3"><a class="reference internal" href="index_advanced_internals.html">Internal Behavior</a></li>
96 <li class="toctree-l3"><a class="reference internal" href="index_advanced_aeh.html">Authentication, Encryption &amp; Hashing</a></li>
97 <li class="toctree-l3"><a class="reference internal" href="index_advanced_servers.html">Servers and Server Lists</a></li>
98 <li class="toctree-l3"><a class="reference internal" href="index_advanced_daemon.html">Affecting the memcached Daemon</a></li>
99 <li class="toctree-l3 current"><a class="reference internal" href="index_advanced_stats.html">Statistics</a><ul class="current">
100 <li class="toctree-l4 current"><a class="current reference internal" href="#">Analyzing servers</a></li>
101 <li class="toctree-l4"><a class="reference internal" href="memcached_stats.html">Working with statistical information from a server</a></li>
102 <li class="toctree-l4"><a class="reference internal" href="memcached_version.html">Getting version information</a></li>
103 </ul>
104 </li>
105 </ul>
106 </li>
107 <li class="toctree-l2"><a class="reference internal" href="index_deprecated.html">Deprecated Functionality</a></li>
108 </ul>
109 </li>
110 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
111 <li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a></li>
112 <li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
113 <li class="toctree-l1"><a class="reference internal" href="index_misc.html">Miscellaneous</a></li>
114 </ul>
115 <ul>
116 <li class="toctree-l1"><a class="reference internal" href="../changelogs.html">Change Logs</a></li>
117 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
118 </ul>
119
120
121
122 </div>
123 </div>
124 </nav>
125
126 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
127
128
129 <nav class="wy-nav-top" aria-label="top navigation">
130
131 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
132 <a href="../index.html">libmemcached</a>
133
134 </nav>
135
136
137 <div class="wy-nav-content">
138
139 <div class="rst-content">
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157 <div role="navigation" aria-label="breadcrumbs navigation">
158
159 <ul class="wy-breadcrumbs">
160
161 <li><a href="../index.html">Docs</a> &raquo;</li>
162
163 <li><a href="index.html">libmemcached API</a> &raquo;</li>
164
165 <li><a href="index_advanced.html">Advanced Topics</a> &raquo;</li>
166
167 <li><a href="index_advanced_stats.html">Statistics</a> &raquo;</li>
168
169 <li>Analyzing servers</li>
170
171
172 <li class="wy-breadcrumbs-aside">
173
174
175
176 <a href="https://github.com/m6w6/libmemcached/blob/v1.x/docs/source/libmemcached/memcached_analyze.rst" class="fa fa-github"> Edit on GitHub</a>
177
178
179
180 </li>
181
182 </ul>
183
184
185 <hr/>
186 </div>
187 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
188 <div itemprop="articleBody">
189
190 <div class="section" id="analyzing-servers">
191 <h1>Analyzing servers<a class="headerlink" href="#analyzing-servers" title="Permalink to this headline"></a></h1>
192 <div class="section" id="synopsis">
193 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline"></a></h2>
194 <dl class="docutils">
195 <dt>#include &lt;libmemcached/memcached.h&gt;</dt>
196 <dd>Compile and link with -lmemcached</dd>
197 </dl>
198 <dl class="type">
199 <dt id="_CPPv421memcached_analysis_st">
200 <span id="_CPPv321memcached_analysis_st"></span><span id="_CPPv221memcached_analysis_st"></span><span id="memcached_analysis_st"></span><em class="property">typedef </em><em class="property">struct</em> <a class="reference internal" href="#_CPPv421memcached_analysis_st" title="memcached_analysis_st">memcached_analysis_st</a> <code class="descname">memcached_analysis_st</code><a class="headerlink" href="#_CPPv421memcached_analysis_st" title="Permalink to this definition"></a><br /></dt>
201 <dd></dd></dl>
202
203 <dl class="function">
204 <dt id="_CPPv417memcached_analyzeP12memcached_stP17memcached_stat_stP18memcached_return_t">
205 <span id="_CPPv317memcached_analyzeP12memcached_stP17memcached_stat_stP18memcached_return_t"></span><span id="_CPPv217memcached_analyzeP12memcached_stP17memcached_stat_stP18memcached_return_t"></span><span id="memcached_analyze__memcached_stP.memcached_stat_stP.memcached_return_tP"></span><a class="reference internal" href="#_CPPv421memcached_analysis_st" title="memcached_analysis_st">memcached_analysis_st</a> *<code class="descname">memcached_analyze</code><span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<em>ptr</em>, <a class="reference internal" href="memcached_stats.html#_CPPv417memcached_stat_st" title="memcached_stat_st">memcached_stat_st</a> *<em>stat</em>, <a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> *<em>error</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv417memcached_analyzeP12memcached_stP17memcached_stat_stP18memcached_return_t" title="Permalink to this definition"></a><br /></dt>
206 <dd><table class="docutils field-list" frame="void" rules="none">
207 <col class="field-name" />
208 <col class="field-body" />
209 <tbody valign="top">
210 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
211 <li><strong>ptr</strong> -- pointer to initialized <a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_st</span></code></a> struct</li>
212 <li><strong>stat</strong> -- pointer to a <a class="reference internal" href="memcached_stats.html#_CPPv417memcached_stat_st" title="memcached_stat_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_stat_st</span></code></a> struct to fill</li>
213 <li><strong>error</strong> -- pointer to <a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_return_t</span></code></a> indicating success</li>
214 </ul>
215 </td>
216 </tr>
217 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">pointer to an allocated and filled out <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_analysis_t</span></code> struct</p>
218 </td>
219 </tr>
220 </tbody>
221 </table>
222 </dd></dl>
223
224 </div>
225 <div class="section" id="description">
226 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
227 <p><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">libmemcached</span></code> has the ability to query a memcached server (or collection of
228 servers) for their current state. Queries to find state return a
229 <a class="reference internal" href="#_CPPv421memcached_analysis_st" title="memcached_analysis_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_analysis_st</span></code></a> structure. You are responsible for freeing this
230 structure.</p>
231 <p><a class="reference internal" href="#_CPPv417memcached_analyzeP12memcached_stP17memcached_stat_stP18memcached_return_t" title="memcached_analyze"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_analyze()</span></code></a> analyzes useful information based on the provided servers
232 and sets the result to the <a class="reference internal" href="#_CPPv421memcached_analysis_st" title="memcached_analysis_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_analysis_st</span></code></a> structure. The return value
233 must be freed by the calling application.</p>
234 <div class="admonition seealso">
235 <p class="first admonition-title">See also</p>
236 <p class="last"><a class="reference internal" href="../bin/memstat.html#cmdoption-memstat-analyze"><code class="xref std std-option docutils literal notranslate"><span class="pre">memstat</span> <span class="pre">--analyze</span></code></a>
237 A command line tool to analyze a memcached server.</p>
238 </div>
239 </div>
240 <div class="section" id="return-value">
241 <h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline"></a></h2>
242 <p>A pointer to the allocated <a class="reference internal" href="#_CPPv421memcached_analysis_st" title="memcached_analysis_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_analysis_st</span></code></a> structure on success and a
243 NULL pointer on failure. You may inspect the error detail by checking the
244 <a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_return_t</span></code></a> value.</p>
245 <p>Any method returning a <a class="reference internal" href="#_CPPv421memcached_analysis_st" title="memcached_analysis_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_analysis_st</span></code></a> expects you to free the memory
246 allocated for it.</p>
247 </div>
248 <div class="section" id="see-also">
249 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
250 <ul class="simple">
251 <li><em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/memcached">memcached(1)</a></em></li>
252 <li><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></li>
253 <li><a class="reference internal" href="memcached_strerror.html"><span class="doc">Converting Error Codes to Messages</span></a></li>
254 </ul>
255 </div>
256 </div>
257
258
259 </div>
260
261 </div>
262 <footer>
263
264 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
265
266 <a href="memcached_stats.html" class="btn btn-neutral float-right" title="Working with statistical information from a server" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
267
268
269 <a href="index_advanced_stats.html" class="btn btn-neutral float-left" title="Statistics" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
270
271 </div>
272
273
274 <hr/>
275
276 <div role="contentinfo">
277 <p>
278 &copy; <a href="../copyright.html">Copyright</a>
279
280 </p>
281 </div>
282 Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
283
284 </footer>
285
286 </div>
287 </div>
288
289 </section>
290
291 </div>
292
293
294
295 <script type="text/javascript">
296 jQuery(function () {
297 SphinxRtdTheme.Navigation.enable(true);
298 });
299 </script>
300
301
302
303
304
305
306 </body>
307 </html>