cvs: phpdoc /en/reference/memcache ini.xml /en/reference/memcache/functions memcache-addserver.xml memcache-getextendedstats.xml
memcache-getserverstatus.xml memcache-getstats.xml memcache-getversion.xml memcache-setserverparams.xml
| From: | Mikael Johansson | Date: | Mon, 09 Oct 2006 18:27:09 +0000 |
| Subject: | cvs: phpdoc /en/reference/memcache ini.xml /en/reference/memcache/functions memcache-addserver.xml memcache-getextendedstats.xml memcache-getserverstatus.xml memcache-getstats.xml memcache-getversion.xml memcache-setserverparams.xml |
||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969374182@lists.php.net to get a copy of this message | ||
mikl Mon Oct 9 18:27:09 2006 UTC
Added files:
/phpdoc/en/reference/memcache/functions
memcache-getserverstatus.xml
memcache-setserverparams.xml
Modified files:
/phpdoc/en/reference/memcache ini.xml
/phpdoc/en/reference/memcache/functions memcache-addserver.xml
memcache-getextendedstats.xml
memcache-getstats.xml
memcache-getversion.xml
Log:
Documentation for new methods and parameters in release 2.1.0
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/memcache/ini.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/memcache/ini.xml diff -u phpdoc/en/reference/memcache/ini.xml:1.3 phpdoc/en/reference/memcache/ini.xml:1.4 --- phpdoc/en/reference/memcache/ini.xml:1.3 Tue Oct 3 10:16:55 2006 +++ phpdoc/en/reference/memcache/ini.xml Mon Oct 9 18:27:09 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <section id="memcache.ini"> &reftitle.runtime; &extension.runtime; @@ -23,6 +23,12 @@ <entry>Available since Memcache 2.0.2</entry> </row> <row> + <entry>memcache.max_failover_attempts</entry> + <entry>"20"</entry> + <entry>PHP_INI_ALL</entry> + <entry>Available since Memcache 2.1.0</entry> + </row> + <row> <entry>memcache.chunk_size</entry> <entry>"8192"</entry> <entry>PHP_INI_ALL</entry> @@ -67,7 +73,6 @@ <para> Defines how many servers to try when setting and getting data. Used only in conjunction with memcache.allow_failover. - This directive is available since version 2.1.0. </para> </listitem> </varlistentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/memcache/functions/memcache-addserver.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/memcache/functions/memcache-addserver.xml diff -u phpdoc/en/reference/memcache/functions/memcache-addserver.xml:1.5 phpdoc/en/reference/memcache/functions/memcache-addserver.xml:1.6 --- phpdoc/en/reference/memcache/functions/memcache-addserver.xml:1.5 Sun Feb 5 12:00:06 2006 +++ phpdoc/en/reference/memcache/functions/memcache-addserver.xml Mon Oct 9 18:27:09 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.Memcache-addServer"> <refnamediv> <refname>Memcache::addServer</refname> @@ -16,6 +16,8 @@ <methodparam choice="opt"><type>int</type><parameter>weight</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>retry_interval</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>status</parameter></methodparam> + <methodparam choice="opt"><type>callback</type><parameter>failure_callback</parameter></methodparam> </methodsynopsis> <para> @@ -98,9 +100,9 @@ <listitem> <para> Controls how often a failed server will be retried, the default value - is 15 seconds. Neither this nor the <parameter>persistent</parameter> - parameter has any effect when this extension is loaded dynamically - via <function>dl</function>. + is 15 seconds. Setting this parameter to -1 disables automatic retry. + Neither this nor the <parameter>persistent</parameter> parameter has any + effect when the extension is loaded dynamically via <function>dl</function>. </para> <para> Each failed connection struct has its own timeout and before it has expired @@ -112,6 +114,29 @@ </para> </listitem> </varlistentry> + <varlistentry> + <term><parameter>status</parameter></term> + <listitem> + <para> + Controls if the server should be flagged as online. Setting this parameter + to &false; and <parameter>retry_interval</parameter> to -1 allows a failed + server to be kept in the pool so as not to affect the key distribution + algoritm. Requests for this server will then failover or fail immediatly + depending on the <parameter>memcache.allow_failover</parameter> setting. + Default to &true;, meaning the server should be considered online. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>failure_callback</parameter></term> + <listitem> + <para> + Allows the user to specify a callback function to run upon encountering an + error. The callback is run before failover is attemped. The function takes + two parameters, the hostname and port of the failed server. + </para> + </listitem> + </varlistentry> </variablelist> </para> </refsect1> @@ -157,6 +182,8 @@ <member><function>Memcache::connect</function></member> <member><function>Memcache::pconnect</function></member> <member><function>Memcache::close</function></member> + <member><function>Memcache::setServerParams</function></member> + <member><function>Memcache::getServerStatus</function></member> </simplelist> </para> </refsect1> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/memcache/functions/memcache-getextendedstats.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/memcache/functions/memcache-getextendedstats.xml diff -u phpdoc/en/reference/memcache/functions/memcache-getextendedstats.xml:1.3 phpdoc/en/reference/memcache/functions/memcache-getextendedstats.xml:1.4 --- phpdoc/en/reference/memcache/functions/memcache-getextendedstats.xml:1.3 Sat Dec 24 23:04:58 2005 +++ phpdoc/en/reference/memcache/functions/memcache-getextendedstats.xml Mon Oct 9 18:27:09 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.Memcache-getExtendedStats"> <refnamediv> <refname>Memcache::getExtendedStats</refname> @@ -10,7 +10,9 @@ &reftitle.description; <methodsynopsis> <type>array</type><methodname>Memcache::getExtendedStats</methodname> - <void/> + <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></methodparam> </methodsynopsis> <para> @@ -29,6 +31,46 @@ </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. Default value + is 100. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/memcache/functions/memcache-getstats.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/memcache/functions/memcache-getstats.xml diff -u phpdoc/en/reference/memcache/functions/memcache-getstats.xml:1.3 phpdoc/en/reference/memcache/functions/memcache-getstats.xml:1.4 --- phpdoc/en/reference/memcache/functions/memcache-getstats.xml:1.3 Fri Dec 23 19:52:06 2005 +++ phpdoc/en/reference/memcache/functions/memcache-getstats.xml Mon Oct 9 18:27:09 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.Memcache-getStats"> <refnamediv> <refname>Memcache::getStats</refname> @@ -10,7 +10,9 @@ &reftitle.description; <methodsynopsis> <type>array</type><methodname>Memcache::getStats</methodname> - <void/> + <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></methodparam> </methodsynopsis> <para> @@ -22,6 +24,46 @@ </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. Default value + is 100. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/memcache/functions/memcache-getversion.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/memcache/functions/memcache-getversion.xml diff -u phpdoc/en/reference/memcache/functions/memcache-getversion.xml:1.2 phpdoc/en/reference/memcache/functions/memcache-getversion.xml:1.3 --- phpdoc/en/reference/memcache/functions/memcache-getversion.xml:1.2 Fri Dec 23 19:52:06 2005 +++ phpdoc/en/reference/memcache/functions/memcache-getversion.xml Mon Oct 9 18:27:09 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.Memcache-getVersion"> <refnamediv> <refname>Memcache::getVersion</refname> @@ -37,14 +37,14 @@ <![CDATA[ <?php -/* procedural API */ -$memcache_obj = memcache_connect('memcache_host', 11211); - -echo memcache_get_version($memcache_obj); - /* OO API */ -$memcache_obj = new Memcache; -echo $memcache_obj->getVersion(); +$memcache = new Memcache; +$memcache->connect('memcache_host', 11211); +echo $memcache->getVersion(); + +/* procedural API */ +$memcache = memcache_connect('memcache_host', 11211); +echo memcache_get_version($memcache); ?> ]]> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/memcache/functions/memcache-getserverstatus.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/memcache/functions/memcache-getserverstatus.xml +++ phpdoc/en/reference/memcache/functions/memcache-getserverstatus.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.Memcache-getServerStatus"> <refnamediv> <refname>Memcache::getServerStatus</refname> <refpurpose>Returns server status</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>int</type><methodname>Memcache::getServerStatus</methodname> <methodparam><type>string</type><parameter>host</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>port</parameter></methodparam> </methodsynopsis> <para> <function>Memcache::getServerStatus</function> returns a the servers online/offline status. You can also use <function>memcache_get_server_status</function> function. </para> <note> <para> This function has been added to Memcache version 2.1.0. </para> </note> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>host</parameter></term> <listitem> <para> Point to the host where memcached is listening for connections. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>port</parameter></term> <listitem> <para> Point to the port where memcached is listening for connections. This parameter is optional and its default value is 11211. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns a the servers status. 0 if server is failed, non-zero otherwise </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title><function>Memcache::getServerStatus</function> example</title> <programlisting role="php"> <![CDATA[ <?php /* OO API */ $memcache = new Memcache; $memcache->addServer('memcache_host', 11211); echo $memcache->getServerStatus('memcache_host', 11211); /* procedural API */ $memcache = memcache_connect('memcache_host', 11211); echo memcache_get_server_status($memcache, 'memcache_host', 11211); ?> ]]> </programlisting> </example> </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function>Memcache::addServer</function></member> <member><function>Memcache::setServerParams</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:"../../../../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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/memcache/functions/memcache-setserverparams.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/memcache/functions/memcache-setserverparams.xml +++ phpdoc/en/reference/memcache/functions/memcache-setserverparams.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.Memcache-setServerParams"> <refnamediv> <refname>Memcache::setServerParams</refname> <refpurpose>Changes server parameters and status at runtime</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>Memcache::setServerParams</methodname> <methodparam><type>string</type><parameter>host</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>port</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>retry_interval</parameter></methodparam> <methodparam choice="opt"><type>bool</type><parameter>status</parameter></methodparam> <methodparam choice="opt"><type>callback</type><parameter>failure_callback</parameter></methodparam> </methodsynopsis> <para> <function>Memcache::setServerParams</function> changes server parameters at runtime. You can also use the <function>memcache_set_server_params</function> function. </para> <note> <para> This function has been added to Memcache version 2.1.0. </para> </note> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>host</parameter></term> <listitem> <para> Point to the host where memcached is listening for connections. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>port</parameter></term> <listitem> <para> Point to the port where memcached is listening for connections. This parameter is optional and its default value is 11211. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>timeout</parameter></term> <listitem> <para> Value in seconds which will be used for connecting to the daemon. Think twice before changing the default value of 1 second - you can loose all the advantages of caching if your connection is too slow. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>retry_interval</parameter></term> <listitem> <para> Controls how often a failed server will be retried, the default value is 15 seconds. Setting this parameter to -1 disables automatic retry. Neither this nor the <parameter>persistent</parameter> parameter has any effect when the extension is loaded dynamically via <function>dl</function>. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>status</parameter></term> <listitem> <para> Controls if the server should be flagged as online. Setting this parameter to &false; and <parameter>retry_interval</parameter> to -1 allows a failed server to be kept in the pool so as not to affect the key distribution algoritm. Requests for this server will then failover or fail immediatly depending on the <parameter>memcache.allow_failover</parameter> setting. Default to &true;, meaning the server should be considered online. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>failure_callback</parameter></term> <listitem> <para> Allows the user to specify a callback function to run upon encountering an error. The callback is run before failover is attemped. The function takes two parameters, the hostname and port of the failed server. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title><function>Memcache::setServerParams</function> example</title> <programlisting role="php"> <![CDATA[ <?php function _callback_memcache_failure($host, $port) { print "memcache '$host:$port' failed"; } /* OO API */ $memcache = new Memcache; // Add the server in offline mode $memcache->addServer('memcache_host', 11211, false, 1, 1, -1, false); // Bring the server back online $memcache->setServerParams('memcache_host', 11211, 1, 15, true, '_callback_memcache_failure'); /* procedural API */ $memcache_obj = memcache_connect('memcache_host', 11211); memcache_set_server_params($memcache_obj, 'memcache_host', 11211, 1, 15, true, '_callback_memcache_failure'); ?> ]]> </programlisting> </example> </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function>Memcache::addServer</function></member> <member><function>Memcache::getServerStatus</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:"../../../../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 -->
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/memcache/ini.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/memcache/ini.xml diff -u phpdoc/en/reference/memcache/ini.xml:1.3 phpdoc/en/reference/memcache/ini.xml:1.4 --- phpdoc/en/reference/memcache/ini.xml:1.3 Tue Oct 3 10:16:55 2006 +++ phpdoc/en/reference/memcache/ini.xml Mon Oct 9 18:27:09 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <section id="memcache.ini"> &reftitle.runtime; &extension.runtime; @@ -23,6 +23,12 @@ <entry>Available since Memcache 2.0.2</entry> </row> <row> + <entry>memcache.max_failover_attempts</entry> + <entry>"20"</entry> + <entry>PHP_INI_ALL</entry> + <entry>Available since Memcache 2.1.0</entry> + </row> + <row> <entry>memcache.chunk_size</entry> <entry>"8192"</entry> <entry>PHP_INI_ALL</entry> @@ -67,7 +73,6 @@ <para> Defines how many servers to try when setting and getting data. Used only in conjunction with memcache.allow_failover. - This directive is available since version 2.1.0. </para> </listitem> </varlistentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/memcache/functions/memcache-addserver.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/memcache/functions/memcache-addserver.xml diff -u phpdoc/en/reference/memcache/functions/memcache-addserver.xml:1.5 phpdoc/en/reference/memcache/functions/memcache-addserver.xml:1.6 --- phpdoc/en/reference/memcache/functions/memcache-addserver.xml:1.5 Sun Feb 5 12:00:06 2006 +++ phpdoc/en/reference/memcache/functions/memcache-addserver.xml Mon Oct 9 18:27:09 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.Memcache-addServer"> <refnamediv> <refname>Memcache::addServer</refname> @@ -16,6 +16,8 @@ <methodparam choice="opt"><type>int</type><parameter>weight</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>retry_interval</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>status</parameter></methodparam> + <methodparam choice="opt"><type>callback</type><parameter>failure_callback</parameter></methodparam> </methodsynopsis> <para> @@ -98,9 +100,9 @@ <listitem> <para> Controls how often a failed server will be retried, the default value - is 15 seconds. Neither this nor the <parameter>persistent</parameter> - parameter has any effect when this extension is loaded dynamically - via <function>dl</function>. + is 15 seconds. Setting this parameter to -1 disables automatic retry. + Neither this nor the <parameter>persistent</parameter> parameter has any + effect when the extension is loaded dynamically via <function>dl</function>. </para> <para> Each failed connection struct has its own timeout and before it has expired @@ -112,6 +114,29 @@ </para> </listitem> </varlistentry> + <varlistentry> + <term><parameter>status</parameter></term> + <listitem> + <para> + Controls if the server should be flagged as online. Setting this parameter + to &false; and <parameter>retry_interval</parameter> to -1 allows a failed + server to be kept in the pool so as not to affect the key distribution + algoritm. Requests for this server will then failover or fail immediatly + depending on the <parameter>memcache.allow_failover</parameter> setting. + Default to &true;, meaning the server should be considered online. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>failure_callback</parameter></term> + <listitem> + <para> + Allows the user to specify a callback function to run upon encountering an + error. The callback is run before failover is attemped. The function takes + two parameters, the hostname and port of the failed server. + </para> + </listitem> + </varlistentry> </variablelist> </para> </refsect1> @@ -157,6 +182,8 @@ <member><function>Memcache::connect</function></member> <member><function>Memcache::pconnect</function></member> <member><function>Memcache::close</function></member> + <member><function>Memcache::setServerParams</function></member> + <member><function>Memcache::getServerStatus</function></member> </simplelist> </para> </refsect1> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/memcache/functions/memcache-getextendedstats.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/memcache/functions/memcache-getextendedstats.xml diff -u phpdoc/en/reference/memcache/functions/memcache-getextendedstats.xml:1.3 phpdoc/en/reference/memcache/functions/memcache-getextendedstats.xml:1.4 --- phpdoc/en/reference/memcache/functions/memcache-getextendedstats.xml:1.3 Sat Dec 24 23:04:58 2005 +++ phpdoc/en/reference/memcache/functions/memcache-getextendedstats.xml Mon Oct 9 18:27:09 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.Memcache-getExtendedStats"> <refnamediv> <refname>Memcache::getExtendedStats</refname> @@ -10,7 +10,9 @@ &reftitle.description; <methodsynopsis> <type>array</type><methodname>Memcache::getExtendedStats</methodname> - <void/> + <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></methodparam> </methodsynopsis> <para> @@ -29,6 +31,46 @@ </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. Default value + is 100. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/memcache/functions/memcache-getstats.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/memcache/functions/memcache-getstats.xml diff -u phpdoc/en/reference/memcache/functions/memcache-getstats.xml:1.3 phpdoc/en/reference/memcache/functions/memcache-getstats.xml:1.4 --- phpdoc/en/reference/memcache/functions/memcache-getstats.xml:1.3 Fri Dec 23 19:52:06 2005 +++ phpdoc/en/reference/memcache/functions/memcache-getstats.xml Mon Oct 9 18:27:09 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.Memcache-getStats"> <refnamediv> <refname>Memcache::getStats</refname> @@ -10,7 +10,9 @@ &reftitle.description; <methodsynopsis> <type>array</type><methodname>Memcache::getStats</methodname> - <void/> + <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></methodparam> </methodsynopsis> <para> @@ -22,6 +24,46 @@ </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. Default value + is 100. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/memcache/functions/memcache-getversion.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/memcache/functions/memcache-getversion.xml diff -u phpdoc/en/reference/memcache/functions/memcache-getversion.xml:1.2 phpdoc/en/reference/memcache/functions/memcache-getversion.xml:1.3 --- phpdoc/en/reference/memcache/functions/memcache-getversion.xml:1.2 Fri Dec 23 19:52:06 2005 +++ phpdoc/en/reference/memcache/functions/memcache-getversion.xml Mon Oct 9 18:27:09 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.Memcache-getVersion"> <refnamediv> <refname>Memcache::getVersion</refname> @@ -37,14 +37,14 @@ <![CDATA[ <?php -/* procedural API */ -$memcache_obj = memcache_connect('memcache_host', 11211); - -echo memcache_get_version($memcache_obj); - /* OO API */ -$memcache_obj = new Memcache; -echo $memcache_obj->getVersion(); +$memcache = new Memcache; +$memcache->connect('memcache_host', 11211); +echo $memcache->getVersion(); + +/* procedural API */ +$memcache = memcache_connect('memcache_host', 11211); +echo memcache_get_version($memcache); ?> ]]> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/memcache/functions/memcache-getserverstatus.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/memcache/functions/memcache-getserverstatus.xml +++ phpdoc/en/reference/memcache/functions/memcache-getserverstatus.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.Memcache-getServerStatus"> <refnamediv> <refname>Memcache::getServerStatus</refname> <refpurpose>Returns server status</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>int</type><methodname>Memcache::getServerStatus</methodname> <methodparam><type>string</type><parameter>host</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>port</parameter></methodparam> </methodsynopsis> <para> <function>Memcache::getServerStatus</function> returns a the servers online/offline status. You can also use <function>memcache_get_server_status</function> function. </para> <note> <para> This function has been added to Memcache version 2.1.0. </para> </note> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>host</parameter></term> <listitem> <para> Point to the host where memcached is listening for connections. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>port</parameter></term> <listitem> <para> Point to the port where memcached is listening for connections. This parameter is optional and its default value is 11211. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns a the servers status. 0 if server is failed, non-zero otherwise </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title><function>Memcache::getServerStatus</function> example</title> <programlisting role="php"> <![CDATA[ <?php /* OO API */ $memcache = new Memcache; $memcache->addServer('memcache_host', 11211); echo $memcache->getServerStatus('memcache_host', 11211); /* procedural API */ $memcache = memcache_connect('memcache_host', 11211); echo memcache_get_server_status($memcache, 'memcache_host', 11211); ?> ]]> </programlisting> </example> </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function>Memcache::addServer</function></member> <member><function>Memcache::setServerParams</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:"../../../../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 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/memcache/functions/memcache-setserverparams.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/memcache/functions/memcache-setserverparams.xml +++ phpdoc/en/reference/memcache/functions/memcache-setserverparams.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.Memcache-setServerParams"> <refnamediv> <refname>Memcache::setServerParams</refname> <refpurpose>Changes server parameters and status at runtime</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>Memcache::setServerParams</methodname> <methodparam><type>string</type><parameter>host</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>port</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>retry_interval</parameter></methodparam> <methodparam choice="opt"><type>bool</type><parameter>status</parameter></methodparam> <methodparam choice="opt"><type>callback</type><parameter>failure_callback</parameter></methodparam> </methodsynopsis> <para> <function>Memcache::setServerParams</function> changes server parameters at runtime. You can also use the <function>memcache_set_server_params</function> function. </para> <note> <para> This function has been added to Memcache version 2.1.0. </para> </note> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>host</parameter></term> <listitem> <para> Point to the host where memcached is listening for connections. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>port</parameter></term> <listitem> <para> Point to the port where memcached is listening for connections. This parameter is optional and its default value is 11211. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>timeout</parameter></term> <listitem> <para> Value in seconds which will be used for connecting to the daemon. Think twice before changing the default value of 1 second - you can loose all the advantages of caching if your connection is too slow. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>retry_interval</parameter></term> <listitem> <para> Controls how often a failed server will be retried, the default value is 15 seconds. Setting this parameter to -1 disables automatic retry. Neither this nor the <parameter>persistent</parameter> parameter has any effect when the extension is loaded dynamically via <function>dl</function>. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>status</parameter></term> <listitem> <para> Controls if the server should be flagged as online. Setting this parameter to &false; and <parameter>retry_interval</parameter> to -1 allows a failed server to be kept in the pool so as not to affect the key distribution algoritm. Requests for this server will then failover or fail immediatly depending on the <parameter>memcache.allow_failover</parameter> setting. Default to &true;, meaning the server should be considered online. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>failure_callback</parameter></term> <listitem> <para> Allows the user to specify a callback function to run upon encountering an error. The callback is run before failover is attemped. The function takes two parameters, the hostname and port of the failed server. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title><function>Memcache::setServerParams</function> example</title> <programlisting role="php"> <![CDATA[ <?php function _callback_memcache_failure($host, $port) { print "memcache '$host:$port' failed"; } /* OO API */ $memcache = new Memcache; // Add the server in offline mode $memcache->addServer('memcache_host', 11211, false, 1, 1, -1, false); // Bring the server back online $memcache->setServerParams('memcache_host', 11211, 1, 15, true, '_callback_memcache_failure'); /* procedural API */ $memcache_obj = memcache_connect('memcache_host', 11211); memcache_set_server_params($memcache_obj, 'memcache_host', 11211, 1, 15, true, '_callback_memcache_failure'); ?> ]]> </programlisting> </example> </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function>Memcache::addServer</function></member> <member><function>Memcache::getServerStatus</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:"../../../../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 -->