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]-->
9 <meta name=
"viewport" content=
"width=device-width, initial-scale=1.0">
11 <title>Analyzing servers
— libmemcached
1.0.99 documentation
</title>
20 <script type=
"text/javascript" src=
"../_static/js/modernizr.min.js"></script>
23 <script type=
"text/javascript" id=
"documentation_options" data-url_root=
"../" src=
"../_static/documentation_options.js"></script>
24 <script src=
"../_static/jquery.js"></script>
25 <script src=
"../_static/underscore.js"></script>
26 <script src=
"../_static/doctools.js"></script>
27 <script src=
"../_static/language_data.js"></script>
29 <script type=
"text/javascript" src=
"../_static/js/theme.js"></script>
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" />
43 <body class=
"wy-body-for-nav">
46 <div class=
"wy-grid-for-nav">
48 <nav data-toggle=
"wy-nav-shift" class=
"wy-nav-side">
49 <div class=
"wy-side-scroll">
50 <div class=
"wy-side-nav-search" >
54 <a href=
"../index.html" class=
"icon icon-home"> libmemcached
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" />
81 <div class=
"wy-menu wy-menu-vertical" data-spy=
"affix" role=
"navigation" aria-label=
"main navigation">
88 <p class=
"caption"><span class=
"caption-text">libmemcached
</span></p>
90 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcached.html">Introduction
</a></li>
91 <li class=
"toctree-l1 current"><a class=
"reference internal" href=
"index.html">libmemcached API
</a><ul class=
"current">
92 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_basics.html">Basics
</a></li>
93 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_data.html">Working with Data
</a></li>
94 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_errors.html">Messages and Errors
</a></li>
95 <li class=
"toctree-l2 current"><a class=
"reference internal" href=
"index_advanced.html">Advanced Topics
</a><ul class=
"current">
96 <li class=
"toctree-l3"><a class=
"reference internal" href=
"index_advanced_internals.html">Internal Behavior
</a></li>
97 <li class=
"toctree-l3"><a class=
"reference internal" href=
"index_advanced_aeh.html">Authentication, Encryption
& Hashing
</a></li>
98 <li class=
"toctree-l3"><a class=
"reference internal" href=
"index_advanced_servers.html">Servers and Server Lists
</a></li>
99 <li class=
"toctree-l3"><a class=
"reference internal" href=
"index_advanced_daemon.html">Affecting the memcached Daemon
</a></li>
100 <li class=
"toctree-l3 current"><a class=
"reference internal" href=
"index_advanced_stats.html">Statistics
</a><ul class=
"current">
101 <li class=
"toctree-l4 current"><a class=
"current reference internal" href=
"#">Analyzing servers
</a></li>
102 <li class=
"toctree-l4"><a class=
"reference internal" href=
"memcached_stats.html">Working with statistical information from a server
</a></li>
107 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_deprecated.html">Deprecated Functionality
</a></li>
110 <li class=
"toctree-l1"><a class=
"reference internal" href=
"index_misc.html">Misc
</a></li>
112 <p class=
"caption"><span class=
"caption-text">libmemcachedutil
</span></p>
114 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcachedutil.html">Introduction
</a></li>
115 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcachedutil/index.html">libmemcachedutil API
</a></li>
117 <p class=
"caption"><span class=
"caption-text">libhashkit
</span></p>
119 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libhashkit.html">Introduction
</a></li>
120 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libhashkit/index.html">libhashkit API
</a></li>
122 <p class=
"caption"><span class=
"caption-text">Client Applications
</span></p>
124 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../bin/index.html">Client Applications
</a></li>
126 <p class=
"caption"><span class=
"caption-text">Copyright
</span></p>
128 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../copyright.html">Copyright
</a></li>
137 <section data-toggle=
"wy-nav-shift" class=
"wy-nav-content-wrap">
140 <nav class=
"wy-nav-top" aria-label=
"top navigation">
142 <i data-toggle=
"wy-nav-top" class=
"fa fa-bars"></i>
143 <a href=
"../index.html">libmemcached
</a>
148 <div class=
"wy-nav-content">
150 <div class=
"rst-content">
168 <div role=
"navigation" aria-label=
"breadcrumbs navigation">
170 <ul class=
"wy-breadcrumbs">
172 <li><a href=
"../index.html">Docs
</a> »</li>
174 <li><a href=
"index.html">libmemcached API
</a> »</li>
176 <li><a href=
"index_advanced.html">Advanced Topics
</a> »</li>
178 <li><a href=
"index_advanced_stats.html">Statistics
</a> »</li>
180 <li>Analyzing servers
</li>
183 <li class=
"wy-breadcrumbs-aside">
194 <div role=
"main" class=
"document" itemscope=
"itemscope" itemtype=
"http://schema.org/Article">
195 <div itemprop=
"articleBody">
197 <div class=
"section" id=
"analyzing-servers">
198 <h1>Analyzing servers
<a class=
"headerlink" href=
"#analyzing-servers" title=
"Permalink to this headline">¶
</a></h1>
199 <div class=
"section" id=
"synopsis">
200 <h2>SYNOPSIS
<a class=
"headerlink" href=
"#synopsis" title=
"Permalink to this headline">¶
</a></h2>
202 <dt>#include
<libmemcached/memcached.h
></dt><dd><p>Compile and link with -lmemcached
</p>
206 <dt id=
"_CPPv421memcached_analysis_st">
207 <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=
"sig-name descname">memcached_analysis_st
</code><a class=
"headerlink" href=
"#_CPPv421memcached_analysis_st" title=
"Permalink to this definition">¶
</a><br /></dt>
210 <dl class=
"function">
211 <dt id=
"_CPPv417memcached_analyzeP12memcached_stP17memcached_stat_stP18memcached_return_t">
212 <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=
"sig-name 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>
216 <div class=
"section" id=
"description">
217 <h2>DESCRIPTION
<a class=
"headerlink" href=
"#description" title=
"Permalink to this headline">¶
</a></h2>
218 <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
219 servers) for their current state. Queries to find state return a
220 <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
222 <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
223 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
224 must be freed by the calling application.
</p>
225 <div class=
"admonition seealso">
226 <p class=
"admonition-title">See also
</p>
227 <p><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>
228 A command line tool to analyze a memcached server.
</p>
231 <div class=
"section" id=
"return-value">
232 <h2>RETURN VALUE
<a class=
"headerlink" href=
"#return-value" title=
"Permalink to this headline">¶
</a></h2>
233 <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
234 NULL pointer on failure. You may inspect the error detail by checking the
235 <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>
236 <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
237 allocated for it.
</p>
239 <div class=
"section" id=
"see-also">
240 <h2>SEE ALSO
<a class=
"headerlink" href=
"#see-also" title=
"Permalink to this headline">¶
</a></h2>
242 <li><p><em class=
"manpage"><a class=
"manpage reference external" href=
"http://man7.org/linux/man-pages/man1/memcached.1.html">memcached(
1)
</a></em></p></li>
243 <li><p><a class=
"reference internal" href=
"../libmemcached.html"><span class=
"doc">C/C++ Client Library for memcached
</span></a></p></li>
244 <li><p><a class=
"reference internal" href=
"memcached_strerror.html"><span class=
"doc">Converting Error Codes to Messages
</span></a></p></li>
255 <div class=
"rst-footer-buttons" role=
"navigation" aria-label=
"footer navigation">
257 <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>
260 <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>
267 <div role=
"contentinfo">
269 © <a href=
"../copyright.html">Copyright
</a>
273 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>.
286 <script type=
"text/javascript">
288 SphinxRtdTheme.Navigation.enable(true);