X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Flibmemcached_configuration.rst;h=01e6b711d99aeca131574ab3c85bb758cb349b2a;hb=55cf7c68679083cdd7351db3b888c6f8ddcebe09;hp=10103f5034ea24515c4a883782f487e899e3e693;hpb=2e5705daa52faa457f104864a27cfbba98ed568e;p=awesomized%2Flibmemcached diff --git a/docs/libmemcached_configuration.rst b/docs/libmemcached_configuration.rst index 10103f50..01e6b711 100644 --- a/docs/libmemcached_configuration.rst +++ b/docs/libmemcached_configuration.rst @@ -24,7 +24,6 @@ Libmemcached implements a custom language for configuring and modifying servers. By passing in an option string you can generate a memcached_st object that you can use in your application directly. - .. describe:: --SERVER=:/? Provide a servername to be used by the client. Providing a weight will cause weighting to occur with all hosts with each server getting a default weight of 1. @@ -61,27 +60,54 @@ Set the distribution model used by the client. See :manpage:`` for more details Set the hashing alogrthm used for placing keys on servers. -.. describe:: --HASH-WITH-PREFIX_KEY - -.. describe:: --IO-BYTES-WATERMARK= +.. describe:: --HASH-WITH-NAMESPACE -.. describe:: --IO-KEY-PREFETCH= - -.. describe:: --IO-MSG-WATERMARK= +When enabled the prefix key will be added to the key when determining which +server to store the data in. .. describe:: --NOREPLY +Enable "no reply" for all calls that support this. It is highly recommended +that you use this option with the binary protocol only. + .. describe:: --NUMBER-OF-REPLICAS= Set the nummber of servers that keys will be replicated to. -.. describe:: --POLL-TIMEOUT= - .. describe:: --RANDOMIZE-REPLICA-READ Select randomly the server within the replication pool to read from. -.. describe:: --RCV-TIMEOUT= +.. describe:: --SORT-HOSTS + +When adding new servers always calculate their distribution based on sorted naming order. + +.. describe:: --SUPPORT-CAS + +See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SUPPORT_CAS + +.. describe:: --USE-UDP + +See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_USE_UDP + +.. describe:: --NAMESPACE= + +A namespace is a container that provides context for keys, only other +requests that know the namespace can access these values. This is +accomplished by prepending the namespace value to all keys. + + +************ +I/O Options: +************ + +.. describe:: --TCP-NODELAY + +See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_TCP_NODELAY + +.. describe:: --TCP-KEEPALIVE + +See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_TCP_KEEPALIVE .. describe:: --RETRY-TIMEOUT= @@ -103,29 +129,26 @@ See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE -.. describe:: --SORT-HOSTS - -When adding new servers always calculate their distribution based on sorted naming order. +.. describe:: --POLL-TIMEOUT= -.. describe:: --SUPPORT-CAS +That sets the value of the timeout used by :manpage: `poll()`. -See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SUPPORT_CAS +.. describe:: --IO-BYTES-WATERMARK= -.. describe:: --TCP-NODELAY +.. describe:: --IO-KEY-PREFETCH= -See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_TCP_NODELAY +.. describe:: --IO-MSG-WATERMARK= -.. describe:: --TCP-KEEPALIVE +.. describe:: --TCP-KEEPIDLE -See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_TCP_KEEPALIVE +.. describe:: --RCV-TIMEOUT= -.. describe:: --TCP-KEEPIDLE -.. describe:: --USE-UDP -See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_USE_UDP +****** +Other: +****** -.. describe:: --PREFIX-KEY= .. describe:: INCLUDE