<!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
- <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
- <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
-
-
- <!--[if lt IE 9]>
- <script src="../_static/js/html5shiv.min.js"></script>
- <![endif]-->
+ <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
<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>
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="copyright" title="Copyright" href="../copyright.html" />
- <link rel="next" title="Deprecated Functionality" href="index_deprecated.html" />
+ <link rel="next" title="Getting version information" href="memcached_version.html" />
<link rel="prev" title="Analyzing servers" href="memcached_analyze.html" />
</head>
- <a href="../index.html" class="icon icon-home" alt="Documentation Home"> libmemcached
+ <a href="../index.html" class="icon icon-home"> libmemcached
</div>
-
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<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>
+<li class="toctree-l4"><a class="reference internal" href="memcached_version.html">Getting version information</a></li>
</ul>
</li>
</ul>
</div>
-
</div>
</nav>
<ul class="wy-breadcrumbs">
- <li><a href="../index.html" class="icon icon-home"></a> »</li>
+ <li><a href="../index.html">Docs</a> »</li>
<li><a href="index.html">libmemcached API</a> »</li>
<p>Get memcached statistics</p>
<div class="section" id="synopsis">
<span id="index-0"></span><h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
-<p>#include <libmemcached/memcached.h></p>
-<dl class="cpp type">
+<dl class="docutils">
+<dt>#include <libmemcached/memcached.h></dt>
+<dd>Compile and link with -lmemcached</dd>
+</dl>
+<dl class="type">
<dt id="_CPPv417memcached_stat_st">
-<span id="_CPPv317memcached_stat_st"></span><span id="_CPPv217memcached_stat_st"></span><span id="memcached_stat_st"></span><em class="property">type
</em><code class="sig-name descname">memcached_stat_st</code><a class="headerlink" href="#_CPPv417memcached_stat_st" title="Permalink to this definition">¶</a><br /></dt>
+<span id="_CPPv317memcached_stat_st"></span><span id="_CPPv217memcached_stat_st"></span><span id="memcached_stat_st"></span><em class="property">type
def </em><em class="property">struct</em> <a class="reference internal" href="#_CPPv417memcached_stat_st" title="memcached_stat_st">memcached_stat_st</a> <code class="descname">memcached_stat_st</code><a class="headerlink" href="#_CPPv417memcached_stat_st" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
-<dl class="cpp type">
+<dl class="type">
<dt id="_CPPv417memcached_stat_fn">
-<span id="_CPPv317memcached_stat_fn"></span><span id="_CPPv217memcached_stat_fn"></span><span id="memcached_stat_fn"></span><em class="property">typedef </em><a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> (*<code class="sig-name descname">memcached_stat_fn</code>)<span class="sig-paren">(</span><em class="property">const</em> memcached_instance_st *server, <em class="property">const</em> char *key, size_t key_length, <em class="property">const</em> char *value, size_t value_length, void *context<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv417memcached_stat_fn" title="Permalink to this definition">¶</a><br /></dt>
-<dd></dd></dl>
-
-<dl class="cpp function">
+<span id="_CPPv317memcached_stat_fn"></span><span id="_CPPv217memcached_stat_fn"></span><span id="memcached_stat_fn"></span><em class="property">typedef </em><a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> (*<code class="descname">memcached_stat_fn</code>)<span class="sig-paren">(</span><em class="property">const</em> memcached_instance_st *server, <em class="property">const</em> char *key, size_t key_length, <em class="property">const</em> char *value, size_t value_length, void *context<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv417memcached_stat_fn" 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>server</strong> -- pointer to the <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_instance_st</span></code> being stat'ed</li>
+<li><strong>key</strong> -- the current key</li>
+<li><strong>key_length</strong> -- the length of the <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">key</span></code> without any terminating zero</li>
+<li><strong>value</strong> -- the value read</li>
+<li><strong>value_length</strong> -- the length of the value without any terminating zero</li>
+<li><strong>context</strong> -- pointer to the user supplied context</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><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>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
<dt id="_CPPv414memcached_statP12memcached_stPcP18memcached_return_t">
-<span id="_CPPv314memcached_statP12memcached_stPcP18memcached_return_t"></span><span id="_CPPv214memcached_statP12memcached_stPcP18memcached_return_t"></span><span id="memcached_stat__memcached_stP.cP.memcached_return_tP"></span><a class="reference internal" href="#_CPPv417memcached_stat_st" title="memcached_stat_st">memcached_stat_st</a> *<code class="sig-name descname">memcached_stat</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>, char *<em>args</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="#_CPPv414memcached_statP12memcached_stPcP18memcached_return_t" title="Permalink to this definition">¶</a><br /></dt>
-<dd></dd></dl>
-
-<dl class="cpp function">
+<span id="_CPPv314memcached_statP12memcached_stPcP18memcached_return_t"></span><span id="_CPPv214memcached_statP12memcached_stPcP18memcached_return_t"></span><span id="memcached_stat__memcached_stP.cP.memcached_return_tP"></span><a class="reference internal" href="#_CPPv417memcached_stat_st" title="memcached_stat_st">memcached_stat_st</a> *<code class="descname">memcached_stat</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>, char *<em>args</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="#_CPPv414memcached_statP12memcached_stPcP18memcached_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 an 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>args</strong> -- particular state object to query</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">array of <a class="reference internal" href="#_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> objects for all available servers</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
<dt id="_CPPv425memcached_stat_servernameP17memcached_stat_stPcPKc9in_port_t">
-<span id="_CPPv325memcached_stat_servernameP17memcached_stat_stPcPKc9in_port_t"></span><span id="_CPPv225memcached_stat_servernameP17memcached_stat_stPcPKc9in_port_t"></span><span id="memcached_stat_servername__memcached_stat_stP.cP.cCP.in_port_t"></span><a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> <code class="sig-name descname">memcached_stat_servername</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv417memcached_stat_st" title="memcached_stat_st">memcached_stat_st</a> *<em>stat</em>, char *<em>args</em>, <em class="property">const</em> char *<em>hostname</em>, in_port_t <em>port</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv425memcached_stat_servernameP17memcached_stat_stPcPKc9in_port_t" title="Permalink to this definition">¶</a><br /></dt>
-<dd></dd></dl>
-
-<dl class="cpp function">
+<span id="_CPPv325memcached_stat_servernameP17memcached_stat_stPcPKc9in_port_t"></span><span id="_CPPv225memcached_stat_servernameP17memcached_stat_stPcPKc9in_port_t"></span><span id="memcached_stat_servername__memcached_stat_stP.cP.cCP.in_port_t"></span><a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> <code class="descname">memcached_stat_servername</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv417memcached_stat_st" title="memcached_stat_st">memcached_stat_st</a> *<em>stat</em>, char *<em>args</em>, <em class="property">const</em> char *<em>hostname</em>, in_port_t <em>port</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv425memcached_stat_servernameP17memcached_stat_stPcPKc9in_port_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>stat</strong> -- pointer to a <a class="reference internal" href="#_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>args</strong> -- particular state object to query</li>
+<li><strong>hostname</strong> -- the hostname or IP address of the server to stat</li>
+<li><strong>port</strong> -- the port of the server to stat</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><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>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
<dt id="_CPPv424memcached_stat_get_valueP12memcached_stP17memcached_stat_stPKcP18memcached_return_t">
-<span id="_CPPv324memcached_stat_get_valueP12memcached_stP17memcached_stat_stPKcP18memcached_return_t"></span><span id="_CPPv224memcached_stat_get_valueP12memcached_stP17memcached_stat_stPKcP18memcached_return_t"></span><span id="memcached_stat_get_value__memcached_stP.memcached_stat_stP.cCP.memcached_return_tP"></span>char *<code class="sig-name descname">memcached_stat_get_value</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="#_CPPv417memcached_stat_st" title="memcached_stat_st">memcached_stat_st</a> *<em>stat</em>, <em class="property">const</em> char *<em>key</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="#_CPPv424memcached_stat_get_valueP12memcached_stP17memcached_stat_stPKcP18memcached_return_t" title="Permalink to this definition">¶</a><br /></dt>
-<dd></dd></dl>
-
-<dl class="cpp function">
+<span id="_CPPv324memcached_stat_get_valueP12memcached_stP17memcached_stat_stPKcP18memcached_return_t"></span><span id="_CPPv224memcached_stat_get_valueP12memcached_stP17memcached_stat_stPKcP18memcached_return_t"></span><span id="memcached_stat_get_value__memcached_stP.memcached_stat_stP.cCP.memcached_return_tP"></span>char *<code class="descname">memcached_stat_get_value</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="#_CPPv417memcached_stat_st" title="memcached_stat_st">memcached_stat_st</a> *<em>stat</em>, <em class="property">const</em> char *<em>key</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="#_CPPv424memcached_stat_get_valueP12memcached_stP17memcached_stat_stPKcP18memcached_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 initialized <a class="reference internal" href="#_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</li>
+<li><strong>key</strong> -- the statistic to query</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">string value of the statistic</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
<dt id="_CPPv423memcached_stat_get_keysP12memcached_stP17memcached_stat_stP18memcached_return_t">
-<span id="_CPPv323memcached_stat_get_keysP12memcached_stP17memcached_stat_stP18memcached_return_t"></span><span id="_CPPv223memcached_stat_get_keysP12memcached_stP17memcached_stat_stP18memcached_return_t"></span><span id="memcached_stat_get_keys__memcached_stP.memcached_stat_stP.memcached_return_tP"></span>char **<code class="sig-name descname">memcached_stat_get_keys</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="#_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="#_CPPv423memcached_stat_get_keysP12memcached_stP17memcached_stat_stP18memcached_return_t" title="Permalink to this definition">¶</a><br /></dt>
-<dd></dd></dl>
-
-<dl class="cpp function">
+<span id="_CPPv323memcached_stat_get_keysP12memcached_stP17memcached_stat_stP18memcached_return_t"></span><span id="_CPPv223memcached_stat_get_keysP12memcached_stP17memcached_stat_stP18memcached_return_t"></span><span id="memcached_stat_get_keys__memcached_stP.memcached_stat_stP.memcached_return_tP"></span>char **<code class="descname">memcached_stat_get_keys</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="#_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="#_CPPv423memcached_stat_get_keysP12memcached_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 initialized <a class="reference internal" href="#_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</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">array of default keys probably available in the statistics</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
<dt id="_CPPv422memcached_stat_executeP12memcached_stPKc17memcached_stat_fnPv">
-<span id="_CPPv322memcached_stat_executeP12memcached_stPKc17memcached_stat_fnPv"></span><span id="_CPPv222memcached_stat_executeP12memcached_stPKc17memcached_stat_fnPv"></span><span id="memcached_stat_execute__memcached_stP.cCP.memcached_stat_fn.voidP"></span><a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> <code class="sig-name descname">memcached_stat_execute</code><span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<em>memc</em>, <em class="property">const</em> char *<em>args</em>, <a class="reference internal" href="#_CPPv417memcached_stat_fn" title="memcached_stat_fn">memcached_stat_fn</a> <em>func</em>, void *<em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv422memcached_stat_executeP12memcached_stPKc17memcached_stat_fnPv" title="Permalink to this definition">¶</a><br /></dt>
-<dd></dd></dl>
+<span id="_CPPv322memcached_stat_executeP12memcached_stPKc17memcached_stat_fnPv"></span><span id="_CPPv222memcached_stat_executeP12memcached_stPKc17memcached_stat_fnPv"></span><span id="memcached_stat_execute__memcached_stP.cCP.memcached_stat_fn.voidP"></span><a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> <code class="descname">memcached_stat_execute</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>, <em class="property">const</em> char *<em>args</em>, <a class="reference internal" href="#_CPPv417memcached_stat_fn" title="memcached_stat_fn">memcached_stat_fn</a> <em>func</em>, void *<em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv422memcached_stat_executeP12memcached_stPKc17memcached_stat_fnPv" 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>args</strong> -- particular state object to query</li>
+<li><strong>func</strong> -- <a class="reference internal" href="#_CPPv417memcached_stat_fn" title="memcached_stat_fn"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_stat_fn</span></code></a> callback</li>
+<li><strong>context</strong> -- pointer to user supplied context</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><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> indication success</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
-<p>Compile and link with -lmemcached</p>
</div>
<div class="section" id="description">
<h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
-<p>libmemcached(3) has the ability to query a memcached server (or collection
-of servers) for their current state. Queries to find state return 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> 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
+<p><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">libmemcached</span></code> has the ability to query a <em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/memcached">memcached(1)</a></em> server (or
+collection of servers) for their current state. Queries to find state return 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> 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="#_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
+<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="#_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 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> returns the value of a particular state key. You specify the key you wish to obtain. The key must be null terminated.</p>
-<p><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> returns a list of keys that the server has state objects on. You are responsible for freeing this list.</p>
-<p>A command line tool, memstat(1), is provided so that you do not have to write
+<p><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> returns the value of a particular state key.
+You specify the key you wish to obtain. The key must be null terminated.</p>
+<p><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> returns a list of keys that the server has state
+objects on. You are responsible for freeing this list.</p>
+<p>A command line tool, <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memstat</span></code>, is provided so that you do not have to write
an application to do this.</p>
</div>
<div class="section" id="return-value">
</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><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>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="index_deprecated.html" class="btn btn-neutral float-right" title="Deprecated Functionality" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="memcached_version.html" class="btn btn-neutral float-right" title="Getting version information" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="memcached_analyze.html" class="btn btn-neutral float-left" title="Analyzing servers" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<div role="contentinfo">
<p>
-
-
© <a href="../copyright.html">Copyright</a>
</p>
</div>
-
-
-
- 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>.
+ 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>.
</footer>
</div>
+
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
projects / m6w6 / libmemcached / blobdiff