git.m6w6.name Git - m6w6/libmemcached/blob - libmemcached/memcached_stats.html

   1
   2
   3 <!DOCTYPE html>
   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]-->
   6 <head>
   7   <meta charset="utf-8">
   8
   9   <meta name="viewport" content="width=device-width, initial-scale=1.0">
  10
  11   <title>Working with statistical information from a server &mdash; libmemcached 1.0.99 documentation</title>
  12
  13
  14
  15
  16
  17
  18
  19
  20   <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
  21
  22
  23       <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
  24         <script type="text/javascript" src="../_static/jquery.js"></script>
  25         <script type="text/javascript" src="../_static/underscore.js"></script>
  26         <script type="text/javascript" src="../_static/doctools.js"></script>
  27         <script type="text/javascript" src="../_static/language_data.js"></script>
  28
  29     <script type="text/javascript" src="../_static/js/theme.js"></script>
  30
  31
  32
  33
  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="Getting version information" href="memcached_version.html" />
  40     <link rel="prev" title="Analyzing servers" href="memcached_analyze.html" />
  41 </head>
  42
  43 <body class="wy-body-for-nav">
  44
  45
  46   <div class="wy-grid-for-nav">
  47
  48     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  49       <div class="wy-side-scroll">
  50         <div class="wy-side-nav-search" >
  51
  52
  53
  54             <a href="../index.html" class="icon icon-home"> libmemcached
  55
  56
  57
  58           </a>
  59
  60
  61
  62
  63               <div class="version">
  64                 1.0
  65               </div>
  66
  67
  68
  69
  70 <div role="search">
  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" />
  75   </form>
  76 </div>
  77
  78
  79         </div>
  80
  81         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  82
  83
  84
  85
  86
  87
  88               <p class="caption"><span class="caption-text">libmemcached</span></p>
  89 <ul class="current">
  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 &amp; 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"><a class="reference internal" href="memcached_analyze.html">Analyzing servers</a></li>
 102 <li class="toctree-l4 current"><a class="current reference internal" href="#">Working with statistical information from a server</a></li>
 103 <li class="toctree-l4"><a class="reference internal" href="memcached_version.html">Getting version information</a></li>
 104 </ul>
 105 </li>
 106 </ul>
 107 </li>
 108 <li class="toctree-l2"><a class="reference internal" href="index_deprecated.html">Deprecated Functionality</a></li>
 109 </ul>
 110 </li>
 111 <li class="toctree-l1"><a class="reference internal" href="index_misc.html">Misc</a></li>
 112 </ul>
 113 <p class="caption"><span class="caption-text">libmemcachedutil</span></p>
 114 <ul>
 115 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil.html">Introduction</a></li>
 116 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
 117 </ul>
 118 <p class="caption"><span class="caption-text">libhashkit</span></p>
 119 <ul>
 120 <li class="toctree-l1"><a class="reference internal" href="../libhashkit.html">Introduction</a></li>
 121 <li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a></li>
 122 </ul>
 123 <p class="caption"><span class="caption-text">Client Applications</span></p>
 124 <ul>
 125 <li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
 126 </ul>
 127 <p class="caption"><span class="caption-text">Copyright</span></p>
 128 <ul>
 129 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
 130 </ul>
 131
 132
 133
 134         </div>
 135       </div>
 136     </nav>
 137
 138     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 139
 140
 141       <nav class="wy-nav-top" aria-label="top navigation">
 142
 143           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 144           <a href="../index.html">libmemcached</a>
 145
 146       </nav>
 147
 148
 149       <div class="wy-nav-content">
 150
 151         <div class="rst-content">
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169 <div role="navigation" aria-label="breadcrumbs navigation">
 170
 171   <ul class="wy-breadcrumbs">
 172
 173       <li><a href="../index.html">Docs</a> &raquo;</li>
 174
 175           <li><a href="index.html">libmemcached API</a> &raquo;</li>
 176
 177           <li><a href="index_advanced.html">Advanced Topics</a> &raquo;</li>
 178
 179           <li><a href="index_advanced_stats.html">Statistics</a> &raquo;</li>
 180
 181       <li>Working with statistical information from a server</li>
 182
 183
 184       <li class="wy-breadcrumbs-aside">
 185
 186
 187
 188       </li>
 189
 190   </ul>
 191
 192
 193   <hr/>
 194 </div>
 195           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 196            <div itemprop="articleBody">
 197
 198   <div class="section" id="working-with-statistical-information-from-a-server">
 199 <h1>Working with statistical information from a server<a class="headerlink" href="#working-with-statistical-information-from-a-server" title="Permalink to this headline">¶</a></h1>
 200 <p>Get memcached statistics</p>
 201 <div class="section" id="synopsis">
 202 <span id="index-0"></span><h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
 203 <dl class="docutils">
 204 <dt>#include &lt;libmemcached/memcached.h&gt;</dt>
 205 <dd>Compile and link with -lmemcached</dd>
 206 </dl>
 207 <dl class="type">
 208 <dt id="_CPPv417memcached_stat_st">
 209 <span id="_CPPv317memcached_stat_st"></span><span id="_CPPv217memcached_stat_st"></span><span id="memcached_stat_st"></span><em class="property">typedef </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>
 210 <dd></dd></dl>
 211
 212 <dl class="type">
 213 <dt id="_CPPv417memcached_stat_fn">
 214 <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>
 215 <dd><table class="docutils field-list" frame="void" rules="none">
 216 <col class="field-name" />
 217 <col class="field-body" />
 218 <tbody valign="top">
 219 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 220 <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>
 221 <li><strong>key</strong> -- the current key</li>
 222 <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>
 223 <li><strong>value</strong> -- the value read</li>
 224 <li><strong>value_length</strong> -- the length of the value without any terminating zero</li>
 225 <li><strong>context</strong> -- pointer to the user supplied context</li>
 226 </ul>
 227 </td>
 228 </tr>
 229 <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>
 230 </td>
 231 </tr>
 232 </tbody>
 233 </table>
 234 </dd></dl>
 235
 236 <dl class="function">
 237 <dt id="_CPPv414memcached_statP12memcached_stPcP18memcached_return_t">
 238 <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>
 239 <dd><table class="docutils field-list" frame="void" rules="none">
 240 <col class="field-name" />
 241 <col class="field-body" />
 242 <tbody valign="top">
 243 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 244 <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>
 245 <li><strong>args</strong> -- particular state object to query</li>
 246 <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>
 247 </ul>
 248 </td>
 249 </tr>
 250 <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>
 251 </td>
 252 </tr>
 253 </tbody>
 254 </table>
 255 </dd></dl>
 256
 257 <dl class="function">
 258 <dt id="_CPPv425memcached_stat_servernameP17memcached_stat_stPcPKc9in_port_t">
 259 <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>
 260 <dd><table class="docutils field-list" frame="void" rules="none">
 261 <col class="field-name" />
 262 <col class="field-body" />
 263 <tbody valign="top">
 264 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 265 <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>
 266 <li><strong>args</strong> -- particular state object to query</li>
 267 <li><strong>hostname</strong> -- the hostname or IP address of the server to stat</li>
 268 <li><strong>port</strong> -- the port of the server to stat</li>
 269 </ul>
 270 </td>
 271 </tr>
 272 <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>
 273 </td>
 274 </tr>
 275 </tbody>
 276 </table>
 277 </dd></dl>
 278
 279 <dl class="function">
 280 <dt id="_CPPv424memcached_stat_get_valueP12memcached_stP17memcached_stat_stPKcP18memcached_return_t">
 281 <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>
 282 <dd><table class="docutils field-list" frame="void" rules="none">
 283 <col class="field-name" />
 284 <col class="field-body" />
 285 <tbody valign="top">
 286 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 287 <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>
 288 <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>
 289 <li><strong>key</strong> -- the statistic to query</li>
 290 <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>
 291 </ul>
 292 </td>
 293 </tr>
 294 <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>
 295 </td>
 296 </tr>
 297 </tbody>
 298 </table>
 299 </dd></dl>
 300
 301 <dl class="function">
 302 <dt id="_CPPv423memcached_stat_get_keysP12memcached_stP17memcached_stat_stP18memcached_return_t">
 303 <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>
 304 <dd><table class="docutils field-list" frame="void" rules="none">
 305 <col class="field-name" />
 306 <col class="field-body" />
 307 <tbody valign="top">
 308 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 309 <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>
 310 <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>
 311 <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>
 312 </ul>
 313 </td>
 314 </tr>
 315 <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>
 316 </td>
 317 </tr>
 318 </tbody>
 319 </table>
 320 </dd></dl>
 321
 322 <dl class="function">
 323 <dt id="_CPPv422memcached_stat_executeP12memcached_stPKc17memcached_stat_fnPv">
 324 <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>
 325 <dd><table class="docutils field-list" frame="void" rules="none">
 326 <col class="field-name" />
 327 <col class="field-body" />
 328 <tbody valign="top">
 329 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 330 <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>
 331 <li><strong>args</strong> -- particular state object to query</li>
 332 <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>
 333 <li><strong>context</strong> -- pointer to user supplied context</li>
 334 </ul>
 335 </td>
 336 </tr>
 337 <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>
 338 </td>
 339 </tr>
 340 </tbody>
 341 </table>
 342 </dd></dl>
 343
 344 </div>
 345 <div class="section" id="description">
 346 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 347 <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
 348 collection of servers) for their current state. Queries to find state return a
 349 <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
 350 structure. While it is possible to access the structure directly it is not
 351 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>
 352 <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>
 353 and executes a &quot;stat&quot; command on each server. args is an optional argument that
 354 can be passed in to modify the behavior of &quot;stats&quot;. You will need to supply a
 355 callback function that will be supplied each pair of values returned by
 356 the memcached server.</p>
 357 <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
 358 containing the state of all available memcached servers. The return value must
 359 be freed by the calling application. If called with the
 360 <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
 361 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>
 362 <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
 363 <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.  &quot;args&quot; is used
 364 to define a particular state object (a list of these are not provided for by either
 365 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
 366 protocol). You must specify the hostname and port of the server you want to
 367 obtain information on.</p>
 368 <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.
 369 You specify the key you wish to obtain.  The key must be null terminated.</p>
 370 <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
 371 objects on. You are responsible for freeing this list.</p>
 372 <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
 373 an application to do this.</p>
 374 </div>
 375 <div class="section" id="return-value">
 376 <h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
 377 <p>Varies, see particular functions.</p>
 378 <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
 379 memory allocated for it.</p>
 380 </div>
 381 <div class="section" id="see-also">
 382 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 383 <ul class="simple">
 384 <li><em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/memcached">memcached(1)</a></em></li>
 385 <li><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></li>
 386 <li><a class="reference internal" href="memcached_strerror.html"><span class="doc">Converting Error Codes to Messages</span></a></li>
 387 </ul>
 388 </div>
 389 </div>
 390
 391
 392            </div>
 393
 394           </div>
 395           <footer>
 396
 397     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 398
 399         <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>
 400
 401
 402         <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>
 403
 404     </div>
 405
 406
 407   <hr/>
 408
 409   <div role="contentinfo">
 410     <p>
 411         &copy; <a href="../copyright.html">Copyright</a>
 412
 413     </p>
 414   </div>
 415   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>.
 416
 417 </footer>
 418
 419         </div>
 420       </div>
 421
 422     </section>
 423
 424   </div>
 425
 426
 427
 428   <script type="text/javascript">
 429       jQuery(function () {
 430           SphinxRtdTheme.Navigation.enable(true);
 431       });
 432   </script>
 433
 434
 435
 436
 437
 438
 439 </body>
 440 </html>