<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
- <script src="../_static/jquery.js"></script>
- <script src="../_static/underscore.js"></script>
- <script src="../_static/doctools.js"></script>
- <script src="../_static/language_data.js"></script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <script type="text/javascript" src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
- <p class="caption"><span class="caption-text">libmemcached</span></p>
-<ul class="current">
+ <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../libmemcached.html">Introduction</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">libmemcached API</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="index_basics.html">Basics</a></li>
<li class="toctree-l3 current"><a class="reference internal" href="index_advanced_stats.html">Statistics</a><ul class="current">
<li class="toctree-l4 current"><a class="current reference internal" href="#">Analyzing servers</a></li>
<li class="toctree-l4"><a class="reference internal" href="memcached_stats.html">Working with statistical information from a server</a></li>
+<li class="toctree-l4"><a class="reference internal" href="memcached_version.html">Getting version information</a></li>
</ul>
</li>
</ul>
<li class="toctree-l2"><a class="reference internal" href="index_deprecated.html">Deprecated Functionality</a></li>
</ul>
</li>
-<li class="toctree-l1"><a class="reference internal" href="index_misc.html">Misc</a></li>
-</ul>
-<p class="caption"><span class="caption-text">libmemcachedutil</span></p>
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
-</ul>
-<p class="caption"><span class="caption-text">libhashkit</span></p>
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="../libhashkit.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a></li>
-</ul>
-<p class="caption"><span class="caption-text">Client Applications</span></p>
-<ul>
<li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
+<li class="toctree-l1"><a class="reference internal" href="index_misc.html">Miscellaneous</a></li>
</ul>
-<p class="caption"><span class="caption-text">Copyright</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../changelogs.html">Change Logs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
</ul>
<li class="wy-breadcrumbs-aside">
+
+ <a href="https://github.com/m6w6/libmemcached/blob/v1.x/docs/source/libmemcached/memcached_analyze.rst" class="fa fa-github"> Edit on GitHub</a>
+
+
</li>
<h1>Analyzing servers<a class="headerlink" href="#analyzing-servers" title="Permalink to this headline">¶</a></h1>
<div class="section" id="synopsis">
<h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
-<dl class="simple">
-<dt>#include <libmemcached/memcached.h></dt><dd><p>Compile and link with -lmemcached</p>
-</dd>
+<dl class="docutils">
+<dt>#include <libmemcached/memcached.h></dt>
+<dd>Compile and link with -lmemcached</dd>
</dl>
<dl class="type">
<dt id="_CPPv421memcached_analysis_st">
-<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>
+<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>
<dd></dd></dl>
<dl class="function">
<dt id="_CPPv417memcached_analyzeP12memcached_stP17memcached_stat_stP18memcached_return_t">
-<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>
-<dd></dd></dl>
+<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>
+<dd><table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<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>
+<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>
+<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>
+</ul>
+</td>
+</tr>
+<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>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
</div>
<div class="section" id="description">
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
must be freed by the calling application.</p>
<div class="admonition seealso">
-<p class="admonition-title">See also</p>
-<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>
+<p class="first admonition-title">See also</p>
+<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>
A command line tool to analyze a memcached server.</p>
</div>
</div>
<div class="section" id="see-also">
<h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
-<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>
-<li><p><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></p></li>
-<li><p><a class="reference internal" href="memcached_strerror.html"><span class="doc">Converting Error Codes to Messages</span></a></p></li>
+<li><em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/memcached">memcached(1)</a></em></li>
+<li><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></li>
+<li><a class="reference internal" href="memcached_strerror.html"><span class="doc">Converting Error Codes to Messages</span></a></li>
</ul>
</div>
</div>
projects / m6w6 / libmemcached / blobdiff