getStats() docs.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@275244 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Andrei Zmievski 2009-02-05 21:20:00 +00:00
parent 22b4492ba0
commit 54d0675dd6

View file

@ -1,20 +1,23 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry xml:id="memcached.getstats" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Memcached::getStats</refname>
<refpurpose>The getStats purpose</refpurpose>
<refpurpose>Get server pool statistics</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Memcached::getStats</methodname>
<modifier>public</modifier> <type>array</type><methodname>Memcached::getStats</methodname>
<void />
</methodsynopsis>
<para>
The method description goes here.
<function>Memcached::getStats</function> returns an array containing the
state of all available memcache servers. See <link
xlink:href="&url.memcache.protocol;">memcache protocol</link> specification
for details on the these statistics.
</para>
</refsect1>
@ -26,7 +29,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Description...
Array of server statistics, one entry per server.
</para>
</refsect1>
@ -38,29 +41,53 @@
<programlisting role="php">
<![CDATA[
<?php
/* ... */
$m = new Memcached();
$m->addServer('localhost', 11211);
print_r($m->getStats());
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
...
Array
(
[localhost:11211] => Array
(
[pid] => 4933
[uptime] => 786123
[threads] => 1
[time] => 1233868010
[pointer_size] => 32
[rusage_user_seconds] => 0
[rusage_user_microseconds] => 140000
[rusage_system_seconds] => 23
[rusage_system_microseconds] => 210000
[curr_items] => 145
[total_items] => 2374
[limit_maxbytes] => 67108864
[curr_connections] => 2
[total_connections] => 151
[connection_structures] => 3
[bytes] => 20345
[cmd_get] => 213343
[cmd_set] => 2381
[get_hits] => 204223
[get_misses] => 9120
[evictions] => 0
[bytes_read] => 9092476
[bytes_written] => 15420512
[version] => 1.2.6
)
)
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>Classname::Method</methodname></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file