1 ========================
2 Configuring Libmemcached
3 ========================
11 #include <libmemcached/memcached.h>
13 .. c:function:: memcached_st *memcached(const char *string, size_t string_length)
15 .. c:function:: memcached_return_t libmemcached_check_configuration(const char *option_string, size_t length, char *error_buffer, size_t error_buffer_size)
17 Compile and link with -lmemcached
24 Libmemcached implements a custom language for configuring and modifying
25 servers. By passing in an option string you can generate a ``memcached_st`` object
26 that you can use in your application directly.
28 .. describe:: --SERVER=<servername>:<optional_port>/?<optional_weight>
30 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.
32 .. describe:: --VERIFY-KEY
34 Verify that keys that are being used fit within the design of the protocol being used.
36 .. describe:: --REMOVE_FAILED_SERVERS
38 Enable the behavior MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS.
40 .. describe:: --BINARY-PROTOCOL
42 Force all connections to use the binary protocol.
44 .. describe:: --BUFFER-REQUESTS
46 Enable MEMCACHED_BEHAVIOR_BUFFER_REQUESTS.
48 .. describe:: --CONFIGURE-FILE=
50 Provide a configuration file to be used to load requests. Beware that by using a configuration file libmemcached will reset memcached_st based on information only contained in the file.
52 .. describe:: --CONNECT-TIMEOUT=
54 Enable MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT.
56 .. describe:: --DISTRIBUTION=
58 Set the distribution model used by the client. See :manpage:`` for more details.
62 Set the hashing alogrthm used for placing keys on servers.
64 .. describe:: --HASH-WITH-NAMESPACE
66 When enabled the prefix key will be added to the key when determining which
67 server to store the data in.
69 .. describe:: --NOREPLY
71 Enable "no reply" for all calls that support this. It is highly recommended
72 that you use this option with the binary protocol only.
74 .. describe:: --NUMBER-OF-REPLICAS=
76 Set the nummber of servers that keys will be replicated to.
78 .. describe:: --RANDOMIZE-REPLICA-READ
80 Select randomly the server within the replication pool to read from.
82 .. describe:: --SORT-HOSTS
84 When adding new servers always calculate their distribution based on sorted naming order.
86 .. describe:: --SUPPORT-CAS
88 See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SUPPORT_CAS
90 .. describe:: --USE-UDP
92 See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_USE_UDP
94 .. describe:: --NAMESPACE=
96 A namespace is a container that provides context for keys, only other
97 requests that know the namespace can access these values. This is
98 accomplished by prepending the namespace value to all keys.
101 **********************
102 Mecached Pool Options:
103 **********************
105 .. describe:: --POOL-MIN
107 Initial size of pool.
109 .. describe:: --POOL-MAX
111 Maximize size of the pool.
117 .. describe:: --TCP-NODELAY
119 See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_TCP_NODELAY
121 .. describe:: --TCP-KEEPALIVE
123 See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_TCP_KEEPALIVE
125 .. describe:: --RETRY-TIMEOUT=
127 See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_RETRY_TIMEOUT
129 .. describe:: --SERVER-FAILURE-LIMIT=
131 See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
133 .. describe:: --SND-TIMEOUT=
135 See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SND_TIMEOUT
137 .. describe:: --SOCKET-RECV-SIZE=
139 See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
141 .. describe:: --SOCKET-SEND-SIZE=
143 See :manpage:`memcached_behavior_set(3)` for MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
145 .. describe:: --POLL-TIMEOUT=
147 That sets the value of the timeout used by :manpage: `poll()`.
149 .. describe:: --IO-BYTES-WATERMARK=
151 .. describe:: --IO-KEY-PREFETCH=
153 .. describe:: --IO-MSG-WATERMARK=
155 .. describe:: --TCP-KEEPIDLE
157 .. describe:: --RCV-TIMEOUT=
166 .. describe:: INCLUDE
168 Include a file in configuration. Unlike --CONFIGURE-FILE= this will not reset memcached_st
172 Reset memcached_st and continue to process.
176 End configutation processing.
180 End configutation processing and throw an error.
188 :c:func:`memcached()` returns a pointer to the memcached_st that was
189 created (or initialized). On an allocation failure, it returns NULL.
200 const char *config_string= "--SERVER=host10.example.com --SERVER=host11.example.com --SERVER=host10.example.com"
201 memcached_st *memc= memcached(config_string, strlen(config_string);
205 memcached_free(memc);
214 To find out more information please check:
215 `http://libmemcached.org/ <http://libmemcached.org/>`_
224 :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`