git.m6w6.name Git - awesomized/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.1.0 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.1
  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               <ul class="current">
  89 <li class="toctree-l1"><a class="reference internal" href="../libmemcached.html">Introduction</a></li>
  90 <li class="toctree-l1 current"><a class="reference internal" href="index.html">libmemcached API</a><ul class="current">
  91 <li class="toctree-l2"><a class="reference internal" href="index_basics.html">Basics</a></li>
  92 <li class="toctree-l2"><a class="reference internal" href="index_data.html">Working with Data</a></li>
  93 <li class="toctree-l2"><a class="reference internal" href="index_errors.html">Messages and Errors</a></li>
  94 <li class="toctree-l2 current"><a class="reference internal" href="index_advanced.html">Advanced Topics</a><ul class="current">
  95 <li class="toctree-l3"><a class="reference internal" href="index_advanced_internals.html">Internal Behavior</a></li>
  96 <li class="toctree-l3"><a class="reference internal" href="index_advanced_aeh.html">Authentication, Encryption &amp; Hashing</a></li>
  97 <li class="toctree-l3"><a class="reference internal" href="index_advanced_servers.html">Servers and Server Lists</a></li>
  98 <li class="toctree-l3"><a class="reference internal" href="index_advanced_daemon.html">Affecting the memcached Daemon</a></li>
  99 <li class="toctree-l3 current"><a class="reference internal" href="index_advanced_stats.html">Statistics</a><ul class="current">
 100 <li class="toctree-l4"><a class="reference internal" href="memcached_analyze.html">Analyzing servers</a></li>
 101 <li class="toctree-l4 current"><a class="current reference internal" href="#">Working with statistical information from a server</a></li>
 102 <li class="toctree-l4"><a class="reference internal" href="memcached_version.html">Getting version information</a></li>
 103 </ul>
 104 </li>
 105 </ul>
 106 </li>
 107 <li class="toctree-l2"><a class="reference internal" href="index_deprecated.html">Deprecated Functionality</a></li>
 108 </ul>
 109 </li>
 110 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
 111 <li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a></li>
 112 <li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
 113 <li class="toctree-l1"><a class="reference internal" href="index_misc.html">Miscellaneous</a></li>
 114 </ul>
 115 <ul>
 116 <li class="toctree-l1"><a class="reference internal" href="../changelogs.html">Change Logs</a></li>
 117 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
 118 </ul>
 119
 120
 121
 122         </div>
 123       </div>
 124     </nav>
 125
 126     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 127
 128
 129       <nav class="wy-nav-top" aria-label="top navigation">
 130
 131           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 132           <a href="../index.html">libmemcached</a>
 133
 134       </nav>
 135
 136
 137       <div class="wy-nav-content">
 138
 139         <div class="rst-content">
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157 <div role="navigation" aria-label="breadcrumbs navigation">
 158
 159   <ul class="wy-breadcrumbs">
 160
 161       <li><a href="../index.html">Docs</a> &raquo;</li>
 162
 163           <li><a href="index.html">libmemcached API</a> &raquo;</li>
 164
 165           <li><a href="index_advanced.html">Advanced Topics</a> &raquo;</li>
 166
 167           <li><a href="index_advanced_stats.html">Statistics</a> &raquo;</li>
 168
 169       <li>Working with statistical information from a server</li>
 170
 171
 172       <li class="wy-breadcrumbs-aside">
 173
 174
 175
 176               <a href="https://github.com/m6w6/libmemcached/blob/v1.x/docs/source/libmemcached/memcached_stats.rst" class="fa fa-github"> Edit on GitHub</a>
 177
 178
 179
 180       </li>
 181
 182   </ul>
 183
 184
 185   <hr/>
 186 </div>
 187           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 188            <div itemprop="articleBody">
 189
 190   <div class="section" id="working-with-statistical-information-from-a-server">
 191 <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>
 192 <p>Get memcached statistics</p>
 193 <div class="section" id="synopsis">
 194 <span id="index-0"></span><h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
 195 <dl class="docutils">
 196 <dt>#include &lt;libmemcached/memcached.h&gt;</dt>
 197 <dd>Compile and link with -lmemcached</dd>
 198 </dl>
 199 <dl class="type">
 200 <dt id="_CPPv417memcached_stat_st">
 201 <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>
 202 <dd></dd></dl>
 203
 204 <dl class="type">
 205 <dt id="_CPPv417memcached_stat_fn">
 206 <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>
 207 <dd><table class="docutils field-list" frame="void" rules="none">
 208 <col class="field-name" />
 209 <col class="field-body" />
 210 <tbody valign="top">
 211 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 212 <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>
 213 <li><strong>key</strong> -- the current key</li>
 214 <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>
 215 <li><strong>value</strong> -- the value read</li>
 216 <li><strong>value_length</strong> -- the length of the value without any terminating zero</li>
 217 <li><strong>context</strong> -- pointer to the user supplied context</li>
 218 </ul>
 219 </td>
 220 </tr>
 221 <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>
 222 </td>
 223 </tr>
 224 </tbody>
 225 </table>
 226 </dd></dl>
 227
 228 <dl class="function">
 229 <dt id="_CPPv414memcached_statP12memcached_stPcP18memcached_return_t">
 230 <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>
 231 <dd><table class="docutils field-list" frame="void" rules="none">
 232 <col class="field-name" />
 233 <col class="field-body" />
 234 <tbody valign="top">
 235 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 236 <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>
 237 <li><strong>args</strong> -- particular state object to query</li>
 238 <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>
 239 </ul>
 240 </td>
 241 </tr>
 242 <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>
 243 </td>
 244 </tr>
 245 </tbody>
 246 </table>
 247 </dd></dl>
 248
 249 <dl class="function">
 250 <dt id="_CPPv425memcached_stat_servernameP17memcached_stat_stPcPKc9in_port_t">
 251 <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>
 252 <dd><table class="docutils field-list" frame="void" rules="none">
 253 <col class="field-name" />
 254 <col class="field-body" />
 255 <tbody valign="top">
 256 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 257 <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>
 258 <li><strong>args</strong> -- particular state object to query</li>
 259 <li><strong>hostname</strong> -- the hostname or IP address of the server to stat</li>
 260 <li><strong>port</strong> -- the port of the server to stat</li>
 261 </ul>
 262 </td>
 263 </tr>
 264 <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>
 265 </td>
 266 </tr>
 267 </tbody>
 268 </table>
 269 </dd></dl>
 270
 271 <dl class="function">
 272 <dt id="_CPPv424memcached_stat_get_valueP12memcached_stP17memcached_stat_stPKcP18memcached_return_t">
 273 <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>
 274 <dd><table class="docutils field-list" frame="void" rules="none">
 275 <col class="field-name" />
 276 <col class="field-body" />
 277 <tbody valign="top">
 278 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 279 <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>
 280 <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>
 281 <li><strong>key</strong> -- the statistic to query</li>
 282 <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>
 283 </ul>
 284 </td>
 285 </tr>
 286 <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>
 287 </td>
 288 </tr>
 289 </tbody>
 290 </table>
 291 </dd></dl>
 292
 293 <dl class="function">
 294 <dt id="_CPPv423memcached_stat_get_keysP12memcached_stP17memcached_stat_stP18memcached_return_t">
 295 <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>
 296 <dd><table class="docutils field-list" frame="void" rules="none">
 297 <col class="field-name" />
 298 <col class="field-body" />
 299 <tbody valign="top">
 300 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 301 <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>
 302 <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>
 303 <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>
 304 </ul>
 305 </td>
 306 </tr>
 307 <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>
 308 </td>
 309 </tr>
 310 </tbody>
 311 </table>
 312 </dd></dl>
 313
 314 <dl class="function">
 315 <dt id="_CPPv422memcached_stat_executeP12memcached_stPKc17memcached_stat_fnPv">
 316 <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>
 317 <dd><table class="docutils field-list" frame="void" rules="none">
 318 <col class="field-name" />
 319 <col class="field-body" />
 320 <tbody valign="top">
 321 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 322 <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>
 323 <li><strong>args</strong> -- particular state object to query</li>
 324 <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>
 325 <li><strong>context</strong> -- pointer to user supplied context</li>
 326 </ul>
 327 </td>
 328 </tr>
 329 <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>
 330 </td>
 331 </tr>
 332 </tbody>
 333 </table>
 334 </dd></dl>
 335
 336 </div>
 337 <div class="section" id="description">
 338 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 339 <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
 340 collection of servers) for their current state. Queries to find state return a
 341 <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
 342 structure. While it is possible to access the structure directly it is not
 343 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>
 344 <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>
 345 and executes a &quot;stat&quot; command on each server. args is an optional argument that
 346 can be passed in to modify the behavior of &quot;stats&quot;. You will need to supply a
 347 callback function that will be supplied each pair of values returned by
 348 the memcached server.</p>
 349 <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
 350 containing the state of all available memcached servers. The return value must
 351 be freed by the calling application. If called with the
 352 <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
 353 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>
 354 <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
 355 <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
 356 to define a particular state object (a list of these are not provided for by either
 357 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
 358 protocol). You must specify the hostname and port of the server you want to
 359 obtain information on.</p>
 360 <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.
 361 You specify the key you wish to obtain.  The key must be null terminated.</p>
 362 <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
 363 objects on. You are responsible for freeing this list.</p>
 364 <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
 365 an application to do this.</p>
 366 </div>
 367 <div class="section" id="return-value">
 368 <h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
 369 <p>Varies, see particular functions.</p>
 370 <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
 371 memory allocated for it.</p>
 372 </div>
 373 <div class="section" id="see-also">
 374 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 375 <ul class="simple">
 376 <li><em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/memcached">memcached(1)</a></em></li>
 377 <li><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></li>
 378 <li><a class="reference internal" href="memcached_strerror.html"><span class="doc">Converting Error Codes to Messages</span></a></li>
 379 </ul>
 380 </div>
 381 </div>
 382
 383
 384            </div>
 385
 386           </div>
 387           <footer>
 388
 389     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 390
 391         <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>
 392
 393
 394         <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>
 395
 396     </div>
 397
 398
 399   <hr/>
 400
 401   <div role="contentinfo">
 402     <p>
 403         &copy; <a href="../copyright.html">Copyright</a>
 404
 405     </p>
 406   </div>
 407   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>.
 408
 409 </footer>
 410
 411         </div>
 412       </div>
 413
 414     </section>
 415
 416   </div>
 417
 418
 419
 420   <script type="text/javascript">
 421       jQuery(function () {
 422           SphinxRtdTheme.Navigation.enable(true);
 423       });
 424   </script>
 425
 426
 427
 428
 429
 430
 431 </body>
 432 </html>