<li class="toctree-l2"><a class="reference internal" href="index_basics.html">Basics</a></li>
<li class="toctree-l2"><a class="reference internal" href="index_data.html">Working with Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="index_errors.html">Messages and Errors</a></li>
-<li class="toctree-l2 current"><a class="reference internal" href="index_advanced.html">Advanced Topics</a></li>
-<li class="toctree-l2"><a class="reference internal" href="index_deprecated.html">Deprecated Functionality</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index_advanced.html">Advanced Topics</a><ul class="current">
+<li class="toctree-l3"><a class="reference internal" href="index_advanced_internals.html">Internal Behavior</a></li>
+<li class="toctree-l3"><a class="reference internal" href="index_advanced_aeh.html">Authentication, Encryption & Hashing</a></li>
+<li class="toctree-l3"><a class="reference internal" href="index_advanced_servers.html">Servers and Server Lists</a></li>
+<li class="toctree-l3"><a class="reference internal" href="index_advanced_daemon.html">Affecting the memcached Daemon</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"><a class="reference internal" href="memcached_analyze.html">Analyzing servers</a></li>
+<li class="toctree-l4 current"><a class="current reference internal" href="#">Working with statistical information from a server</a></li>
</ul>
</li>
-<li class="toctree-l1"><a class="reference internal" href="index_misc.html">Misc</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="configuration.html">Configuration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="constants.html">Constants</a></li>
-<li class="toctree-l2"><a class="reference internal" href="examples.html">Examples</a></li>
-<li class="toctree-l2"><a class="reference internal" href="versioning.html">Versioning</a></li>
</ul>
</li>
+<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><ul>
-<li class="toctree-l2"><a class="reference internal" href="../libmemcachedutil/memcached_pool.html">Working with memcached pools</a></li>
-</ul>
-</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><ul>
-<li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_create.html">Creating a hashkit structure</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_function.html">Set Hash Function</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_functions.html">Available Hashes</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_value.html">Generate hash value</a></li>
-</ul>
-</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><ul>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memcapable.html">memcapable - Checking a Memcached server capabilities and compatibility</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memcat.html">memcat - “cat” data from a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memcp.html">memcp - Copy data to a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memdump.html">memdump - Dumping your server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memerror.html">memerror - translate an error code to a string</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memflush.html">memflush - flush all data from a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memrm.html">memrm - Remove data from a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memslap.html">memslap - Load testing and benchmarking a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memaslap.html">memaslap - Load testing and benchmarking a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memstat.html">memstat - Gather statistics from a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memexist.html">memexist - Check for the existence of a key</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memparse.html">memparse - Parse an option string</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memping.html">memping - Test to see if a server is available.</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memtouch.html">memtouch - Touches a key.</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
</ul>
-</li>
+<p class="caption"><span class="caption-text">Copyright</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
</ul>
<a class="reference internal" href="#_CPPv417memcached_stat_st" title="memcached_stat_st"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_stat_st</span></code></a> structure. You are responsible for freeing this structure. While it is possible to access the structure directly it is not advisable. <a class="reference internal" href="#_CPPv424memcached_stat_get_valueP12memcached_stP17memcached_stat_stPKcP18memcached_return_t" title="memcached_stat_get_value"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_stat_get_value()</span></code></a> has been provided to query the structure.</p>
<p><a class="reference internal" href="#_CPPv422memcached_stat_executeP12memcached_stPKc17memcached_stat_fnPv" title="memcached_stat_execute"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_stat_execute()</span></code></a> uses the servers found in <a class="reference internal" href="#_CPPv417memcached_stat_st" title="memcached_stat_st"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_stat_st</span></code></a> and executes a “stat” command on each server. args is an optional argument that can be passed in to modify the behavior of “stats”. You will need to supply a callback function that will be supplied each pair of values returned by
the memcached server.</p>
-<p><a class="reference internal" href="#_CPPv414memcached_statP12memcached_stPcP18memcached_return_t" title="memcached_stat"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_stat()</span></code></a> fetches an array of <a class="reference internal" href="#_CPPv417memcached_stat_st" title="memcached_stat_st"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_stat_st</span></code></a> structures containing the state of all available memcached servers. The return value must be freed by the calling application. If called with the <
a class="reference internal" href="memcached_behavior.html#_CPPv4N20memcached_behavior_t26MEMCACHED_BEHAVIOR_USE_UDPE" title="MEMCACHED_BEHAVIOR_USE_UDP"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_USE_UDP</span></code></a> behavior set, a NULL value is returned and the error parameter is set to <a class="reference internal" href="memcached_return_t.html#_CPPv4N18memcached_return_t23MEMCACHED_NOT_SUPPORTEDE" title="MEMCACHED_NOT_SUPPORTED"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_NOT_SUPPORTED</span></code></a>.</p>
+<p><a class="reference internal" href="#_CPPv414memcached_statP12memcached_stPcP18memcached_return_t" title="memcached_stat"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_stat()</span></code></a> fetches an array of <a class="reference internal" href="#_CPPv417memcached_stat_st" title="memcached_stat_st"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_stat_st</span></code></a> structures containing the state of all available memcached servers. The return value must be freed by the calling application. If called with the <
code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_USE_UDP</span></code> behavior set, a NULL value is returned and the error parameter is set to <a class="reference internal" href="memcached_return_t.html#_CPPv4N18memcached_return_t23MEMCACHED_NOT_SUPPORTEDE" title="MEMCACHED_NOT_SUPPORTED"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_NOT_SUPPORTED</span></code></a>.</p>
<p><a class="reference internal" href="#_CPPv425memcached_stat_servernameP17memcached_stat_stPcPKc9in_port_t" title="memcached_stat_servername"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_stat_servername()</span></code></a> can be used standalone without a <a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_st</span></code></a> to obtain the state of a particular server. “args” is used to define a particular state object (a list of these are not provided for by either
the <a class="reference internal" href="#_CPPv423memcached_stat_get_keysP12memcached_stP17memcached_stat_stP18memcached_return_t" title="memcached_stat_get_keys"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_stat_get_keys()</span></code></a> call nor are they defined in the memcached protocol). You must specify the hostname and port of the server you want to
obtain information on.</p>
<p>A command line tool, memstat(1), is provided so that you do not have to write
an application to do this.</p>
</div>
-<div class="section" id="return">
-<h2>RETURN<a class="headerlink" href="#return" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="return-value">
+<h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
<p>Varies, see particular functions.</p>
<p>Any method returning a <a class="reference internal" href="#_CPPv417memcached_stat_st" title="memcached_stat_st"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_stat_st</span></code></a> expects you to free the
memory allocated for it.</p>
projects / awesomized / libmemcached / blobdiff