reference/memcached/memcached/getstats.xml
5e6bdba53b93f200cfd6068ce5d9b328c3a4459b
5e6bdba53b93f200cfd6068ce5d9b328c3a4459b
...
...
@@ -1,6 +1,5 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
4
3
<refentry xml:id="memcached.getstats" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
5
4
<refnamediv>
6
5
<refname>Memcached::getStats</refname>
...
...
@@ -9,27 +8,38 @@
9
8
10
9
<refsect1 role="description">
11
10
&reftitle.description;
12
-
<methodsynopsis>
13
-
<modifier>public</modifier> <type>array</type><methodname>Memcached::getStats</methodname>
14
-
<void />
11
+
<methodsynopsis role="Memcached">
12
+
<modifier>public</modifier> <type class="union"><type>array</type><type>false</type></type><methodname>Memcached::getStats</methodname>
13
+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>type</parameter><initializer>&null;</initializer></methodparam>
15
14
</methodsynopsis>
16
15
<para>
17
16
<function>Memcached::getStats</function> returns an array containing the
18
-
state of all available memcache servers. See <link
19
-
xlink:href="&url.memcache.protocol;">memcache protocol</link> specification
20
-
for details on these statistics.
17
+
state of all available memcache servers. See
18
+
<link xlink:href="&url.memcache.protocol;">memcache protocol</link>
19
+
specification for details on these statistics.
21
20
</para>
22
21
</refsect1>
23
22
24
23
<refsect1 role="parameters">
25
24
&reftitle.parameters;
26
-
&no.function.parameters;
25
+
<para>
26
+
<variablelist>
27
+
<varlistentry>
28
+
<term><parameter>type</parameter></term>
29
+
<listitem>
30
+
<para>
31
+
The type of statistics to fetch.
32
+
</para>
33
+
</listitem>
34
+
</varlistentry>
35
+
</variablelist>
36
+
</para>
27
37
</refsect1>
28
38
29
39
<refsect1 role="returnvalues">
30
40
&reftitle.returnvalues;
31
41
<para>
32
-
Array of server statistics, one entry per server.
42
+
Array of server statistics, one entry per server, &return.falseforfailure;.
33
43
</para>
34
44
</refsect1>
35
45
...
...
@@ -89,7 +99,6 @@ Array
89
99
</refsect1>
90
100
91
101
</refentry>
92
-
93
102
<!-- Keep this comment at the end of the file
94
103
Local variables:
95
104
mode: sgml
96
105