<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Get statistics of the server</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="memcache.getserverstatus.html">Memcache::getServerStatus</a></div>
<div class="next" style="text-align: right; float: right;"><a href="memcache.getversion.html">Memcache::getVersion</a></div>
<div class="up"><a href="class.memcache.html">Memcache</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="memcache.getstats" class="refentry">
<div class="refnamediv">
<h1 class="refname">Memcache::getStats</h1>
<p class="verinfo">(PECL memcache >= 0.2.0)</p><p class="refpurpose"><span class="refname">Memcache::getStats</span> — <span class="dc-title">Get statistics of the server</span></p>
</div>
<div class="refsect1 description" id="refsect1-memcache.getstats-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>Memcache::getStats</strong></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$type</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$slabid</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$limit</code><span class="initializer"> = 100</span></span>
]]] )</div>
<p class="para rdfs-comment">
<span class="function"><strong>Memcache::getStats()</strong></span> returns an associative array
with server's statistics. Array keys correspond to stats parameters and
values to parameter's values.
Also you can use <span class="function"><strong>memcache_get_stats()</strong></span> function.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-memcache.getstats-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">type</code></em></span>
<dd>
<p class="para">
The type of statistics to fetch. Valid values are {reset,
malloc, maps, cachedump, slabs, items, sizes}. According to
the memcached protocol spec these additional arguments "are
subject to change for the convenience of memcache developers".
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">slabid</code></em></span>
<dd>
<p class="para">
Used in conjunction with <em><code class="parameter">type</code></em> set to
cachedump to identify the slab to dump from. The cachedump
command ties up the server and is strictly to be used for
debugging purposes.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">limit</code></em></span>
<dd>
<p class="para">
Used in conjunction with <em><code class="parameter">type</code></em> set to
cachedump to limit the number of entries to dump.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-memcache.getstats-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an associative array of server statistics or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-memcache.getstats-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="memcache.getversion.html" class="function" rel="rdfs-seeAlso">Memcache::getVersion()</a> - Return version of the server</span></li>
<li class="member"> <span class="function"><a href="memcache.getextendedstats.html" class="function" rel="rdfs-seeAlso">Memcache::getExtendedStats()</a> - Get statistics from all servers in pool</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="memcache.getserverstatus.html">Memcache::getServerStatus</a></div>
<div class="next" style="text-align: right; float: right;"><a href="memcache.getversion.html">Memcache::getVersion</a></div>
<div class="up"><a href="class.memcache.html">Memcache</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
