mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
docs progress
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@275309 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Andrei Zmievski
parent
f4d16c3936
commit
f3d0135425
3 changed files with 72 additions and 23 deletions
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
|
||||
<book xml:id="book.memcached" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<title>Memcached</title>
|
||||
|
|
@ -7,11 +7,6 @@
|
|||
|
||||
<preface xml:id="intro.memcached">
|
||||
&reftitle.intro;
|
||||
<note>
|
||||
<para>
|
||||
The documentation is currently being worked on.
|
||||
</para>
|
||||
</note>
|
||||
<para>
|
||||
<link xlink:href="&url.memcache;">memcached</link> is a high-performance,
|
||||
distributed memory object caching system, generic in nature, but intended
|
||||
|
|
@ -34,6 +29,7 @@
|
|||
&reference.memcached.examples;
|
||||
&reference.memcached.expiration;
|
||||
&reference.memcached.callbacks;
|
||||
&reference.memcached.sessions;
|
||||
&reference.memcached.memcached;
|
||||
|
||||
</book>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
|
||||
<appendix xml:id="memcached.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
&reftitle.constants;
|
||||
|
|
@ -9,112 +9,137 @@
|
|||
<varlistentry xml:id="memcached.constants.opt-compression">
|
||||
<term><constant>Memcached::OPT_COMPRESSION</constant></term>
|
||||
<listitem>
|
||||
<para>Description here...</para>
|
||||
<para>Enables or disables payload compression. When enabled,
|
||||
item values longer than a certain threshold (currently 100 bytes) will be
|
||||
compressed during storage and decompressed during retrieval
|
||||
transparently.</para>
|
||||
<para>Type: <literal>boolean</literal>, default: &true;.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry xml:id="memcached.constants.opt-prefix-key">
|
||||
<term><constant>Memcached::OPT_PREFIX_KEY</constant></term>
|
||||
<listitem>
|
||||
<para>Description here...</para>
|
||||
<para>This can be used to create a "domain" for your item keys. The value
|
||||
specified here will be prefixed to each of the keys. It cannot be
|
||||
longer than <literal>128</literal> characters and will reduce the
|
||||
maximum available key size. The prefix is applied only to the item keys,
|
||||
not to the server keys.</para>
|
||||
<para>Type: <literal>string</literal>, default: <literal>""</literal>.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry xml:id="memcached.constants.opt-hash">
|
||||
<term><constant>Memcached::OPT_HASH</constant></term>
|
||||
<listitem>
|
||||
<para>Description here...</para>
|
||||
<para>Specifies the hashing algorithm used for the item keys. The valid
|
||||
values are supplied via <constant>Memcached::HASH_*</constant> constants.
|
||||
Each hash algorithm has its advantages and its disadvantages. Go with the
|
||||
default if you don't know or don't care.</para>
|
||||
<para>Type: <literal>integer</literal>, default: <constant>Memcached::HASH_DEFAULT</constant></para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry xml:id="memcached.constants.hash-default">
|
||||
<term><constant>Memcached::HASH_DEFAULT</constant></term>
|
||||
<listitem>
|
||||
<para>Description here...</para>
|
||||
<para>The default (Jenkins one-at-a-time) item key hashing algorithm.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry xml:id="memcached.constants.hash-md5">
|
||||
<term><constant>Memcached::HASH_MD5</constant></term>
|
||||
<listitem>
|
||||
<para>Description here...</para>
|
||||
<para>MD5 item key hashing algorithm.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry xml:id="memcached.constants.hash-crc">
|
||||
<term><constant>Memcached::HASH_CRC</constant></term>
|
||||
<listitem>
|
||||
<para>Description here...</para>
|
||||
<para>CRC item key hashing algorithm.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry xml:id="memcached.constants.hash-fnv1-64">
|
||||
<term><constant>Memcached::HASH_FNV1_64</constant></term>
|
||||
<listitem>
|
||||
<para>Description here...</para>
|
||||
<para>FNV1_64 item key hashing algorithm.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry xml:id="memcached.constants.hash-fnv1a-64">
|
||||
<term><constant>Memcached::HASH_FNV1A_64</constant></term>
|
||||
<listitem>
|
||||
<para>Description here...</para>
|
||||
<para>FNV1_64A item key hashing algorithm.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry xml:id="memcached.constants.hash-fnv1-32">
|
||||
<term><constant>Memcached::HASH_FNV1_32</constant></term>
|
||||
<listitem>
|
||||
<para>Description here...</para>
|
||||
<para>FNV1_32 item key hashing algorithm.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry xml:id="memcached.constants.hash-fnv1a-32">
|
||||
<term><constant>Memcached::HASH_FNV1A_32</constant></term>
|
||||
<listitem>
|
||||
<para>Description here...</para>
|
||||
<para>FNV1_32A item key hashing algorithm.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry xml:id="memcached.constants.hash-hsieh">
|
||||
<term><constant>Memcached::HASH_HSIEH</constant></term>
|
||||
<listitem>
|
||||
<para>Description here...</para>
|
||||
<para>Hsieh item key hashing algorithm.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry xml:id="memcached.constants.hash-murmur">
|
||||
<term><constant>Memcached::HASH_MURMUR</constant></term>
|
||||
<listitem>
|
||||
<para>Description here...</para>
|
||||
<para>Murmur item key hashing algorithm.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry xml:id="memcached.constants.opt-distribution">
|
||||
<term><constant>Memcached::OPT_DISTRIBUTION</constant></term>
|
||||
<listitem>
|
||||
<para>Description here...</para>
|
||||
<para>Specifies the method of distributing item keys to the servers.
|
||||
Currently supported methods are modulo and consistent hashing. Consistent
|
||||
hashing delivers better distribution and allows servers to be added to
|
||||
the cluster with minimal cache losses.</para>
|
||||
<para>Type: <literal>integer</literal>, default: <constant>Memcached::DISTRIBUTION_MODULA.</constant></para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry xml:id="memcached.constants.distribution-modula">
|
||||
<term><constant>Memcached::DISTRIBUTION_MODULA</constant></term>
|
||||
<listitem>
|
||||
<para>Description here...</para>
|
||||
<para>Modulo-based key distribution algorithm.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry xml:id="memcached.constants.distribution-consistent">
|
||||
<term><constant>Memcached::DISTRIBUTION_CONSISTENT</constant></term>
|
||||
<listitem>
|
||||
<para>Description here...</para>
|
||||
<para>Consistent hashing key distribution algorithm (based on libketama).</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry xml:id="memcached.constants.opt-libketama-compatible">
|
||||
<term><constant>Memcached::OPT_LIBKETAMA_COMPATIBLE</constant></term>
|
||||
<listitem>
|
||||
<para>Description here...</para>
|
||||
<para>Enables or disables compatibility with libketama-like behavior. When
|
||||
enabled, the item key hashing algorithm is set to MD5 and distribution is
|
||||
set to be weighted consistent hashing distribution. This is useful
|
||||
because other libketama-based clients (Python, Ruby, etc.) with the same
|
||||
server configuration will be able to access the keys transparently.
|
||||
<note>It is highly recommended to enable this option if you want to use
|
||||
consistent hashing, and it may be enabled by default in future
|
||||
releases.</note></para>
|
||||
<para>Type: <literal>boolean</literal>, default: &false;.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
|
|
|
|||
28
reference/memcached/sessions.xml
Normal file
28
reference/memcached/sessions.xml
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
|
||||
<chapter xml:id="memcached.sessions" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<title>Sessions support</title>
|
||||
<para>...</para>
|
||||
</chapter>
|
||||
|
||||
<!-- 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
|
||||
-->
|
||||
Loading…
Reference in a new issue