<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="memcache.getstats" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>Memcache::getStats</refname>
  <refpurpose>Get statistics of the server</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>Memcache::getStats</methodname>
   <methodparam choice="opt"><type>string</type><parameter>type</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>slabid</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>limit</parameter><initializer>100</initializer></methodparam>
  </methodsynopsis>

  <para>
   <function>Memcache::getStats</function> returns an associative array 
   with server's statistics. Array keys correspond to stats parameters and 
   values to parameter's values.
   Also you can use <function>memcache_get_stats</function> function.
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>type</parameter></term>
     <listitem>
      <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".
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>slabid</parameter></term>
     <listitem>
      <para>
       Used in conjunction with <parameter>type</parameter> 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.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>limit</parameter></term>
     <listitem>
      <para>
       Used in conjunction with <parameter>type</parameter> set to 
       cachedump to limit the number of entries to dump.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an associative array of server statistics&return.falseforfailure;.
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>Memcache::getVersion</function></member>
    <member><function>Memcache::getExtendedStats</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
