<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<section xml:id="memcache.ini" xmlns="http://docbook.org/ns/docbook">
 &reftitle.runtime;
 &extension.runtime;
 <para>
  <table>
   <title>Memcache Configuration Options</title>
   <tgroup cols="4">
    <thead>
     <row>
      <entry>&Name;</entry>
      <entry>&Default;</entry>
      <entry>&Changeable;</entry>
      <entry>&Changelog;</entry>
     </row>
    </thead>
    <tbody xml:id="memcache.ini.list">
     <row>
      <entry><link linkend="ini.memcache.allow-failover">memcache.allow_failover</link></entry>
      <entry>"1"</entry>
      <entry>PHP_INI_ALL</entry>
      <entry>Available since memcache 2.0.2.</entry>
     </row>
     <row>
      <entry><link linkend="ini.memcache.max-failover-attempts">memcache.max_failover_attempts</link></entry>
      <entry>"20"</entry>
      <entry>PHP_INI_ALL</entry>
      <entry>Available since memcache 2.1.0.</entry>
     </row>
     <row>
      <entry><link linkend="ini.memcache.chunk-size">memcache.chunk_size</link></entry>
      <entry>"8192"</entry>
      <entry>PHP_INI_ALL</entry>
      <entry>Available since memcache 2.0.2.</entry>
     </row>
     <row>
      <entry><link linkend="ini.memcache.default-port">memcache.default_port</link></entry>
      <entry>"11211"</entry>
      <entry>PHP_INI_ALL</entry>
      <entry>Available since memcache 2.0.2.</entry>
     </row>
     <row>
      <entry><link linkend="ini.memcache.hash-strategy">memcache.hash_strategy</link></entry>
      <entry>"standard"</entry>
      <entry>PHP_INI_ALL</entry>
      <entry>Available since memcache 2.2.0.</entry>
     </row>
     <row>
      <entry><link linkend="ini.memcache.hash-function">memcache.hash_function</link></entry>
      <entry>"crc32"</entry>
      <entry>PHP_INI_ALL</entry>
      <entry>Available since memcache 2.2.0.</entry>
     </row>
     <row>
      <entry><link linkend="ini.memcache.protocol">memcache.protocol</link></entry>
      <entry>ascii</entry>
      <entry>>PHP_INI_ALL</entry>
      <entry>Supported since memcache 3.0.0</entry>
     </row>
     <row>
      <entry><link linkend="ini.memcache.redundancy">memcache.redundancy</link></entry>
      <entry>1</entry>
      <entry>>PHP_INI_ALL</entry>
      <entry>Supported since memcache 3.0.0</entry>
     </row>
     <row>
      <entry><link linkend="ini.memcache.session-redundancy">memcache.session_redundancy</link></entry>
      <entry>2</entry>
      <entry>>PHP_INI_ALL</entry>
      <entry>Supported since memcache 3.0.0</entry>
     </row>
     <row>
      <entry><link linkend="ini.memcache.compress-threshold">memcache.compress_threshold</link></entry>
      <entry>20000</entry>
      <entry>>PHP_INI_ALL</entry>
      <entry>Supported since memcache 3.0.3</entry>
     </row>
     <row>
      <entry><link linkend="ini.memcache.lock-timeout">memcache.lock_timeout</link></entry>
      <entry>15</entry>
      <entry>>PHP_INI_ALL</entry>
      <entry>Supported since memcache 3.0.4</entry>
     </row>
    </tbody>
   </tgroup>
  </table>
  <table>
   <title>Session Configuration Options Affecting Memcache Behavior</title>
   <tgroup cols="4">
    <thead>
     <row>
      <entry>&Name;</entry>
      <entry>&Default;</entry>
      <entry>&Changeable;</entry>
      <entry>&Changelog;</entry>
     </row>
    </thead>
    <tbody xml:id="memcache.ini.list.extra">
     <row>
      <entry><link linkend="ini.memcache.save-handler">session.save_handler</link></entry>
      <entry>"files"</entry>
      <entry>PHP_INI_ALL</entry>
      <entry>Supported since memcache 2.1.2</entry>
     </row>
     <row>
      <entry><link linkend="ini.memcache.save-path">session.save_path</link></entry>
      <entry>""</entry>
      <entry>PHP_INI_ALL</entry>
      <entry>Supported since memcache 2.1.2</entry>
     </row>
    </tbody>
   </tgroup>
  </table>
  &ini.php.constants;
 </para>

&ini.descriptions.title;

<para>
 <variablelist>
  
  <varlistentry xml:id="ini.memcache.allow-failover">
   <term>
    <parameter>memcache.allow_failover</parameter>
    <type>bool</type>
   </term>
   <listitem>
    <para>
     Whether to transparently failover to other servers on 
     errors.
    </para>
   </listitem>
  </varlistentry>
  
  <varlistentry xml:id="ini.memcache.max-failover-attempts">
   <term>
    <parameter>memcache.max_failover_attempts</parameter>
    <type>int</type>
   </term>
   <listitem>
    <para>
     Defines how many servers to try when setting and getting data.
     Used only in conjunction with memcache.allow_failover.
    </para>
   </listitem>
  </varlistentry>
  
  <varlistentry xml:id="ini.memcache.chunk-size">
   <term>
    <parameter>memcache.chunk_size</parameter>
    <type>int</type>
   </term>
   <listitem>
    <para>
     Data will be transferred in chunks of this size, setting
     the value lower requires more network writes. Try 
     increasing this value to 32768 if noticing otherwise 
     inexplicable slowdowns.
    </para>
   </listitem>
  </varlistentry>
  
  <varlistentry xml:id="ini.memcache.default-port">
   <term>
    <parameter>memcache.default_port</parameter>
    <type>string</type>
   </term>
   <listitem>
    <para>
     The default TCP port number to use when connecting to
     the memcached server if no other port is specified.
    </para>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="ini.memcache.hash-strategy">
   <term>
    <parameter>memcache.hash_strategy</parameter>
    <type>string</type>
   </term>
   <listitem>
    <para>
     Controls which strategy to use when mapping keys to servers. Set this value to 
     <literal>consistent</literal> to enable consistent hashing which allows servers 
     to be added or removed from the pool without causing keys to be remapped.
     Setting this value to <literal>standard</literal> results in the old strategy
     being used.
    </para>
   </listitem>
  </varlistentry>
  
  <varlistentry xml:id="ini.memcache.hash-function">
   <term>
    <parameter>memcache.hash_function</parameter>
    <type>string</type>
   </term>
   <listitem>
    <para>
     Controls which hash function to apply when mapping keys to servers, <literal>crc32</literal> 
     uses the standard CRC32 hash while <literal>fnv</literal> uses FNV-1a.
    </para>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="ini.memcache.protocol">
   <term>
    <parameter>memcache.protocol</parameter>
    <type>string</type>
   </term>
   <listitem>
    <para>
     
    </para>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="ini.memcache.redundancy">
   <term>
    <parameter>memcache.redundancy</parameter>
    <type>int</type>
   </term>
   <listitem>
    <para>
     
    </para>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="ini.memcache.session-redundancy">
   <term>
    <parameter>memcache.session_redundancy</parameter>
    <type>int</type>
   </term>
   <listitem>
    <para>
     
    </para>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="ini.memcache.compress-threshold">
   <term>
    <parameter>memcache.compress_threshold</parameter>
    <type>int</type>
   </term>
   <listitem>
    <para>
     
    </para>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="ini.memcache.lock-timeout">
   <term>
    <parameter>memcache.lock_timeout</parameter>
    <type>int</type>
   </term>
   <listitem>
    <para>
     
    </para>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="ini.memcache.save-handler">
   <term>
    <parameter>session.save_handler</parameter>
    <type>string</type>
   </term>
   <listitem>
    <para>
     Use memcache as a session handler by setting this value to <literal>memcache</literal>.
    </para>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="ini.memcache.save-path">
   <term>
    <parameter>session.save_path</parameter>
    <type>string</type>
   </term>
   <listitem>
    <para>
     Defines a comma separated of server urls to use for session storage, for example
     <literal>"tcp://host1:11211, tcp://host2:11211"</literal>.
    </para>
    <para>
     Each url may contain parameters which are applied to that server, they are the same 
     as for the <function>Memcache::addServer</function> method. For example 
     <literal>"tcp://host1:11211?persistent=1&amp;weight=1&amp;timeout=1&amp;retry_interval=15"</literal>
    </para>
   </listitem>
  </varlistentry>

 </variablelist>
</para>
</section>

<!-- 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
-->
