php-doc-en/reference/tokyo_tyrant/ini.xml
TAKAGI Masahiro 2e7ac38b15 added svn:keywords to track $Revision$.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@287587 c90b9560-bf6c-de11-be94-00142212c4b1
2009-08-23 00:43:36 +00:00

157 lines
4.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<section xml:id="tokyo-tyrant.configuration" xmlns="http://docbook.org/ns/docbook">
&reftitle.runtime;
&extension.runtime;
<para>
<table>
<title>tokyo_tyrant &ConfigureOptions;</title>
<tgroup cols="4">
<thead>
<row>
<entry>&Name;</entry>
<entry>&Default;</entry>
<entry>&Changeable;</entry>
<entry>&Changelog;</entry>
</row>
</thead>
<tbody>
<row>
<entry>tokyo_tyrant.default_timeout</entry>
<entry>2.0</entry>
<entry>PHP_INI_ALL</entry>
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
</row>
<row>
<entry>tokyo_tyrant.session_salt</entry>
<entry>&null;</entry>
<entry>PHP_INI_ALL</entry>
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
</row>
<row>
<entry>tokyo_tyrant.key_prefix</entry>
<entry>&null;</entry>
<entry>PHP_INI_ALL</entry>
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
</row>
<row>
<entry>tokyo_tyrant.allow_failover</entry>
<entry>1</entry>
<entry>PHP_INI_ALL</entry>
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
</row>
<row>
<entry>tokyo_tyrant.fail_threshold</entry>
<entry>5</entry>
<entry>PHP_INI_ALL</entry>
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
</row>
<row>
<entry>tokyo_tyrant.health_check_divisor</entry>
<entry>1000</entry>
<entry>PHP_INI_ALL</entry>
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
</row>
<row>
<entry>tokyo_tyrant.php_expiration</entry>
<entry>0</entry>
<entry>PHP_INI_ALL</entry>
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
&ini.descriptions.title;
<para>
<variablelist>
<varlistentry xml:id="ini.tokyo-tyrant.default-timeout">
<term>
<parameter>tokyo_tyrant.default_timeout</parameter>
<type>integer</type>
</term>
<listitem>
<para>
Default timeout when connecting to databases
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.tokyo-tyrant.session-salt">
<term>
<parameter>tokyo_tyrant.session_salt</parameter>
<type>string</type>
</term>
<listitem>
<para>
The secret that is used to salt session id
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.tokyo-tyrant.key-prefix">
<term>
<parameter>tokyo_tyrant.key_prefix</parameter>
<type>string</type>
</term>
<listitem>
<para>
Prefix all keys with this string. The prefix is transparent
to the developer but helps making sure that keys won't collide if multiple
applications are using the same database.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.tokyo-tyrant.allow-failover">
<term>
<parameter>tokyo_tyrant.allow_failover</parameter>
<type>integer</type>
</term>
<listitem>
<para>
Whether to allow session failover in case a server dies.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.tokyo-tyrant.fail-threshold">
<term>
<parameter>tokyo_tyrant.fail_threshold</parameter>
<type>integer</type>
</term>
<listitem>
<para>
How many read/write or connection failures is allowed
before server is marked as failed.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.tokyo-tyrant.health-check-divisor">
<term>
<parameter>tokyo_tyrant.health_check_divisor</parameter>
<type>integer</type>
</term>
<listitem>
<para>
Defines the divisor for the health check probability. If there are failed
servers and the probability matches, the servers are health checked and
in case the server seems healthy, it will be added back to the pool.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.tokyo-tyrant.php-expiration">
<term>
<parameter>tokyo_tyrant.php_expiration</parameter>
<type>integer</type>
</term>
<listitem>
<para>
Whether to use built in session expiration mechanism or delegate
the expiration to a lua-script on the server-side.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</section>