4 <html class=
"writer-html5" lang=
"en" >
8 <meta name=
"viewport" content=
"width=device-width, initial-scale=1.0">
10 <title>Analyzing servers
— libmemcached
1.0.99 documentation
</title>
14 <link rel=
"stylesheet" href=
"../_static/css/theme.css" type=
"text/css" />
15 <link rel=
"stylesheet" href=
"../_static/pygments.css" type=
"text/css" />
24 <script src="../_static/js/html5shiv.min.js"></script>
28 <script type=
"text/javascript" id=
"documentation_options" data-url_root=
"../" src=
"../_static/documentation_options.js"></script>
29 <script src=
"../_static/jquery.js"></script>
30 <script src=
"../_static/underscore.js"></script>
31 <script src=
"../_static/doctools.js"></script>
32 <script src=
"../_static/language_data.js"></script>
34 <script type=
"text/javascript" src=
"../_static/js/theme.js"></script>
37 <link rel=
"index" title=
"Index" href=
"../genindex.html" />
38 <link rel=
"search" title=
"Search" href=
"../search.html" />
39 <link rel=
"copyright" title=
"Copyright" href=
"../copyright.html" />
40 <link rel=
"next" title=
"Working with statistical information from a server" href=
"memcached_stats.html" />
41 <link rel=
"prev" title=
"Statistics" href=
"index_advanced_stats.html" />
44 <body class=
"wy-body-for-nav">
47 <div class=
"wy-grid-for-nav">
49 <nav data-toggle=
"wy-nav-shift" class=
"wy-nav-side">
50 <div class=
"wy-side-scroll">
51 <div class=
"wy-side-nav-search" >
55 <a href=
"../index.html" class=
"icon icon-home" alt=
"Documentation Home"> libmemcached
72 <form id=
"rtd-search-form" class=
"wy-form" action=
"../search.html" method=
"get">
73 <input type=
"text" name=
"q" placeholder=
"Search docs" />
74 <input type=
"hidden" name=
"check_keywords" value=
"yes" />
75 <input type=
"hidden" name=
"area" value=
"default" />
83 <div class=
"wy-menu wy-menu-vertical" data-spy=
"affix" role=
"navigation" aria-label=
"main navigation">
90 <p class=
"caption"><span class=
"caption-text">libmemcached
</span></p>
92 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcached.html">Introduction
</a></li>
93 <li class=
"toctree-l1 current"><a class=
"reference internal" href=
"index.html">libmemcached API
</a><ul class=
"current">
94 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_basics.html">Basics
</a></li>
95 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_data.html">Working with Data
</a></li>
96 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_errors.html">Messages and Errors
</a></li>
97 <li class=
"toctree-l2 current"><a class=
"reference internal" href=
"index_advanced.html">Advanced Topics
</a><ul class=
"current">
98 <li class=
"toctree-l3"><a class=
"reference internal" href=
"index_advanced_internals.html">Internal Behavior
</a></li>
99 <li class=
"toctree-l3"><a class=
"reference internal" href=
"index_advanced_aeh.html">Authentication, Encryption
& Hashing
</a></li>
100 <li class=
"toctree-l3"><a class=
"reference internal" href=
"index_advanced_servers.html">Servers and Server Lists
</a></li>
101 <li class=
"toctree-l3"><a class=
"reference internal" href=
"index_advanced_daemon.html">Affecting the memcached Daemon
</a></li>
102 <li class=
"toctree-l3 current"><a class=
"reference internal" href=
"index_advanced_stats.html">Statistics
</a><ul class=
"current">
103 <li class=
"toctree-l4 current"><a class=
"current reference internal" href=
"#">Analyzing servers
</a></li>
104 <li class=
"toctree-l4"><a class=
"reference internal" href=
"memcached_stats.html">Working with statistical information from a server
</a></li>
109 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_deprecated.html">Deprecated Functionality
</a></li>
112 <li class=
"toctree-l1"><a class=
"reference internal" href=
"index_misc.html">Misc
</a></li>
114 <p class=
"caption"><span class=
"caption-text">libmemcachedutil
</span></p>
116 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcachedutil.html">Introduction
</a></li>
117 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcachedutil/index.html">libmemcachedutil API
</a></li>
119 <p class=
"caption"><span class=
"caption-text">libhashkit
</span></p>
121 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libhashkit.html">Introduction
</a></li>
122 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libhashkit/index.html">libhashkit API
</a></li>
124 <p class=
"caption"><span class=
"caption-text">Client Applications
</span></p>
126 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../bin/index.html">Client Applications
</a></li>
128 <p class=
"caption"><span class=
"caption-text">Copyright
</span></p>
130 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../copyright.html">Copyright
</a></li>
140 <section data-toggle=
"wy-nav-shift" class=
"wy-nav-content-wrap">
143 <nav class=
"wy-nav-top" aria-label=
"top navigation">
145 <i data-toggle=
"wy-nav-top" class=
"fa fa-bars"></i>
146 <a href=
"../index.html">libmemcached
</a>
151 <div class=
"wy-nav-content">
153 <div class=
"rst-content">
171 <div role=
"navigation" aria-label=
"breadcrumbs navigation">
173 <ul class=
"wy-breadcrumbs">
175 <li><a href=
"../index.html" class=
"icon icon-home"></a> »</li>
177 <li><a href=
"index.html">libmemcached API
</a> »</li>
179 <li><a href=
"index_advanced.html">Advanced Topics
</a> »</li>
181 <li><a href=
"index_advanced_stats.html">Statistics
</a> »</li>
183 <li>Analyzing servers
</li>
186 <li class=
"wy-breadcrumbs-aside">
197 <div role=
"main" class=
"document" itemscope=
"itemscope" itemtype=
"http://schema.org/Article">
198 <div itemprop=
"articleBody">
200 <div class=
"section" id=
"analyzing-servers">
201 <h1>Analyzing servers
<a class=
"headerlink" href=
"#analyzing-servers" title=
"Permalink to this headline">¶
</a></h1>
202 <div class=
"section" id=
"synopsis">
203 <h2>SYNOPSIS
<a class=
"headerlink" href=
"#synopsis" title=
"Permalink to this headline">¶
</a></h2>
205 <dt>#include
<libmemcached/memcached.h
></dt><dd><p>Compile and link with -lmemcached
</p>
208 <dl class=
"cpp type">
209 <dt id=
"_CPPv421memcached_analysis_st">
210 <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>
213 <dl class=
"cpp function">
214 <dt id=
"_CPPv417memcached_analyzeP12memcached_stP17memcached_stat_stP18memcached_return_t">
215 <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 <dd><dl class=
"field-list simple">
217 <dt class=
"field-odd">Parameters
</dt>
218 <dd class=
"field-odd"><ul class=
"simple">
219 <li><p><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
</p></li>
220 <li><p><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
</p></li>
221 <li><p><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
</p></li>
224 <dt class=
"field-even">Returns
</dt>
225 <dd class=
"field-even"><p>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>
231 <div class=
"section" id=
"description">
232 <h2>DESCRIPTION
<a class=
"headerlink" href=
"#description" title=
"Permalink to this headline">¶
</a></h2>
233 <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
234 servers) for their current state. Queries to find state return a
235 <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
237 <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
238 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
239 must be freed by the calling application.
</p>
240 <div class=
"admonition seealso">
241 <p class=
"admonition-title">See also
</p>
242 <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>
243 A command line tool to analyze a memcached server.
</p>
246 <div class=
"section" id=
"return-value">
247 <h2>RETURN VALUE
<a class=
"headerlink" href=
"#return-value" title=
"Permalink to this headline">¶
</a></h2>
248 <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
249 NULL pointer on failure. You may inspect the error detail by checking the
250 <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>
251 <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
252 allocated for it.
</p>
254 <div class=
"section" id=
"see-also">
255 <h2>SEE ALSO
<a class=
"headerlink" href=
"#see-also" title=
"Permalink to this headline">¶
</a></h2>
257 <li><p><em class=
"manpage"><a class=
"manpage reference external" href=
"https://linux.die.net/man/1/memcached">memcached(
1)
</a></em></p></li>
258 <li><p><a class=
"reference internal" href=
"../libmemcached.html"><span class=
"doc">C/C++ Client Library for memcached
</span></a></p></li>
259 <li><p><a class=
"reference internal" href=
"memcached_strerror.html"><span class=
"doc">Converting Error Codes to Messages
</span></a></p></li>
270 <div class=
"rst-footer-buttons" role=
"navigation" aria-label=
"footer navigation">
272 <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>
275 <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>
282 <div role=
"contentinfo">
286 © <a href=
"../copyright.html">Copyright
</a>
293 Built with
<a href=
"http://sphinx-doc.org/">Sphinx
</a> using a
295 <a href=
"https://github.com/rtfd/sphinx_rtd_theme">theme
</a>
297 provided by
<a href=
"https://readthedocs.org">Read the Docs
</a>.
309 <script type=
"text/javascript">
311 SphinxRtdTheme.Navigation.enable(true);