diff --git a/reference/memcached/book.xml b/reference/memcached/book.xml index be8497535c..4c83630888 100644 --- a/reference/memcached/book.xml +++ b/reference/memcached/book.xml @@ -1,5 +1,5 @@ - + Memcached @@ -7,11 +7,6 @@ &reftitle.intro; - - - The documentation is currently being worked on. - - memcached 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; diff --git a/reference/memcached/constants.xml b/reference/memcached/constants.xml index 6828e3042b..fbfdd8202e 100644 --- a/reference/memcached/constants.xml +++ b/reference/memcached/constants.xml @@ -1,5 +1,5 @@ - + &reftitle.constants; @@ -9,112 +9,137 @@ Memcached::OPT_COMPRESSION - Description here... + 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. + Type: boolean, default: &true;. Memcached::OPT_PREFIX_KEY - Description here... + 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 128 characters and will reduce the + maximum available key size. The prefix is applied only to the item keys, + not to the server keys. + Type: string, default: "". Memcached::OPT_HASH - Description here... + Specifies the hashing algorithm used for the item keys. The valid + values are supplied via Memcached::HASH_* constants. + Each hash algorithm has its advantages and its disadvantages. Go with the + default if you don't know or don't care. + Type: integer, default: Memcached::HASH_DEFAULT Memcached::HASH_DEFAULT - Description here... + The default (Jenkins one-at-a-time) item key hashing algorithm. Memcached::HASH_MD5 - Description here... + MD5 item key hashing algorithm. Memcached::HASH_CRC - Description here... + CRC item key hashing algorithm. Memcached::HASH_FNV1_64 - Description here... + FNV1_64 item key hashing algorithm. Memcached::HASH_FNV1A_64 - Description here... + FNV1_64A item key hashing algorithm. Memcached::HASH_FNV1_32 - Description here... + FNV1_32 item key hashing algorithm. Memcached::HASH_FNV1A_32 - Description here... + FNV1_32A item key hashing algorithm. Memcached::HASH_HSIEH - Description here... + Hsieh item key hashing algorithm. Memcached::HASH_MURMUR - Description here... + Murmur item key hashing algorithm. Memcached::OPT_DISTRIBUTION - Description here... + 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. + Type: integer, default: Memcached::DISTRIBUTION_MODULA. Memcached::DISTRIBUTION_MODULA - Description here... + Modulo-based key distribution algorithm. Memcached::DISTRIBUTION_CONSISTENT - Description here... + Consistent hashing key distribution algorithm (based on libketama). Memcached::OPT_LIBKETAMA_COMPATIBLE - Description here... + 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. + 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. + Type: boolean, default: &false;. diff --git a/reference/memcached/sessions.xml b/reference/memcached/sessions.xml new file mode 100644 index 0000000000..7bcf292b10 --- /dev/null +++ b/reference/memcached/sessions.xml @@ -0,0 +1,28 @@ + + + + + Sessions support + ... + + +