X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Flibmemcached_configuration.rst;h=e0f51b12f432665801912fc7c93bb42d9dd14f0f;hb=38c7c4e5444881eee8f76c6050e146c137c3781e;hp=10103f5034ea24515c4a883782f487e899e3e693;hpb=8b33bb5adbffec6e701728c085e4606a2f7cd506;p=m6w6%2Flibmemcached diff --git a/docs/libmemcached_configuration.rst b/docs/libmemcached_configuration.rst index 10103f50..e0f51b12 100644 --- a/docs/libmemcached_configuration.rst +++ b/docs/libmemcached_configuration.rst @@ -2,40 +2,46 @@ Configuring Libmemcached ======================== +.. highlightlang:: c + -------- SYNOPSIS -------- +#include -.. c:function:: memcached_st *memcached_create_with_options(const char *string, size_t string_length) +.. envvar:: LIBMEMCACHED +.. c:function:: memcached_st *memcached(const char *string, size_t string_length) .. c:function:: memcached_return_t libmemcached_check_configuration(const char *option_string, size_t length, char *error_buffer, size_t error_buffer_size) Compile and link with -lmemcached - ----------- DESCRIPTION ----------- Libmemcached implements a custom language for configuring and modifying -servers. By passing in an option string you can generate a memcached_st object +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. +.. describe:: --SOCKET=\"/?\" + +Provide a filepath to a UNIX socket file. Providing a weight will cause weighting to occur with all hosts with each server getting a default weight of 1. + .. describe:: --VERIFY-KEY Verify that keys that are being used fit within the design of the protocol being used. .. describe:: --REMOVE_FAILED_SERVERS -Enable the behavior MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS. +Enable the behavior :c:type:`MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS`. .. describe:: --BINARY-PROTOCOL @@ -43,7 +49,7 @@ Force all connections to use the binary protocol. .. describe:: --BUFFER-REQUESTS -Enable MEMCACHED_BEHAVIOR_BUFFER_REQUESTS. +Please see :c:type:`MEMCACHED_BEHAVIOR_BUFFER_REQUESTS`. .. describe:: --CONFIGURE-FILE= @@ -51,7 +57,7 @@ Provide a configuration file to be used to load requests. Beware that by using a .. describe:: --CONNECT-TIMEOUT= -Enable MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT. +Please see :c:type:`MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT`. .. describe:: --DISTRIBUTION= @@ -61,27 +67,66 @@ 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:: --IO-KEY-PREFETCH= +.. describe:: --HASH-WITH-NAMESPACE -.. 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 :c:type:`MEMCACHED_BEHAVIOR_SUPPORT_CAS` + +.. describe:: --USE-UDP + +See :manpage:`memcached_behavior_set(3)` for :c:type:`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. + + +********************** +Mecached Pool Options: +********************** + +.. describe:: --POOL-MIN + +Initial size of pool. + +.. describe:: --POOL-MAX + +Maximize size of the pool. + +************ +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 +148,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 @@ -149,7 +191,7 @@ RETURN ------ -memcached_create_with_options() returns a pointer to the memcached_st that was +:c:func:`memcached()` returns a pointer to the memcached_st that was created (or initialized). On an allocation failure, it returns NULL. @@ -162,7 +204,7 @@ EXAMPLE .. code-block:: c const char *config_string= "--SERVER=host10.example.com --SERVER=host11.example.com --SERVER=host10.example.com" - memcached_st *memc= memcached_create_with_options(config_string, strlen(config_string); + memcached_st *memc= memcached(config_string, strlen(config_string); { ... } @@ -176,7 +218,7 @@ HOME To find out more information please check: -`https://launchpad.net/libmemcached `_ +`http://libmemcached.org/ `_