libmemcached Configuration — libmemcached 1.0.99 documentation

libmemcached ConfigurationÂ¶

SYNOPSISÂ¶

#include <libmemcached-1.0/memcached.h>: Compile and link with -lmemcached
-

Parameters:	+ string -- configuration string + string_length -- length of the configuration string without any terminating zero - - Returns - allocated and initialized `memcached_st` struct - - +
Returns:	allocated and initialized `memcached_st` struct +

Parameters:	+ option_string -- configuration string + length -- length of the configuration string without any terminating zero + error_buffer -- buffer used to store any error message + error_buffer_size -- available size of the `error_buffer` - - Returns - `memcached_return_t` indicating success - - +
Returns:	`memcached_return_t` indicating success +

General Options:Â¶

---SERVER=<servername>:<optional_port>/?<optional_weight>

+--SERVER=<servername>:<optional_port>/?<optional_weight>

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.

@@ -241,7 +238,7 @@ server getting a default weight of 1.

---SOCKET=\"<filepath>/?<optional_weight>\"

--SOCKET="<filepath>/?<optional_weight>"

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.

@@ -249,32 +246,32 @@ of 1.

---VERIFY-KEY: Verify that keys that are being used fit within the design of the protocol being used.

---REMOVE_FAILED_SERVERS: Enable the behavior MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS.

---BINARY-PROTOCOL: Force all connections to use the binary protocol.

---BUFFER-REQUESTS: Please see MEMCACHED_BEHAVIOR_BUFFER_REQUESTS.

---CONFIGURE-FILE=

--CONFIGURE-FILE=

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.

@@ -282,71 +279,71 @@ on information only contained in the file.

---CONNECT-TIMEOUT=: See memcached_behavior_set() for MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT.

---DISTRIBUTION=: Set the distribution model used by the client. See memcached_behavior_set() for more details.

---HASH=: Set the hashing algorithm used for placing keys on servers.

---HASH-WITH-NAMESPACE: When enabled the prefix key will be added to the key when determining which server to store the data in.

---NOREPLY: Enable "no reply" for all calls that support this. It is highly recommended that you use this option with the binary protocol only.

---NUMBER-OF-REPLICAS=: Set the number of servers that keys will be replicated to.

---RANDOMIZE-REPLICA-READ: Select randomly the server within the replication pool to read from.

---SORT-HOSTS: When adding new servers always calculate their distribution based on sorted naming order.

---SUPPORT-CAS: See memcached_behavior_set() for MEMCACHED_BEHAVIOR_SUPPORT_CAS

---USE-UDP: See memcached_behavior_set() for MEMCACHED_BEHAVIOR_USE_UDP

---NAMESPACE=

--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.

@@ -357,13 +354,13 @@ accomplished by prepending the namespace value to all keys.

Memcached Pool Options:Â¶

---POOL-MIN: Initial size of pool.

---POOL-MAX: Maximize size of the pool.

@@ -372,75 +369,75 @@ accomplished by prepending the namespace value to all keys.

I/O Options:Â¶

---TCP-NODELAY: See memcached_behavior_set() for MEMCACHED_BEHAVIOR_TCP_NODELAY

---TCP-KEEPALIVE: See memcached_behavior_set() for MEMCACHED_BEHAVIOR_TCP_KEEPALIVE

---RETRY-TIMEOUT=: See memcached_behavior_set() for MEMCACHED_BEHAVIOR_RETRY_TIMEOUT

---SERVER-FAILURE-LIMIT=: See memcached_behavior_set() for MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT

---SND-TIMEOUT=: See memcached_behavior_set() for MEMCACHED_BEHAVIOR_SND_TIMEOUT

---SOCKET-RECV-SIZE=: See memcached_behavior_set() for MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE

---SOCKET-SEND-SIZE=: See memcached_behavior_set() for MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE

---POLL-TIMEOUT=: Set the timeout used by poll(3).

---IO-BYTES-WATERMARK=

---IO-KEY-PREFETCH=

---IO-MSG-WATERMARK=

---TCP-KEEPIDLE

---RCV-TIMEOUT=

@@ -448,26 +445,26 @@ accomplished by prepending the namespace value to all keys.

Other Options:Â¶

-INCLUDE: Include a file in configuration. Unlike --CONFIGURE-FILE= this will not reset memcached_st.

-RESET: Reset memcached_st and continue to process.

-END: End configuration processing.

-ERROR: End configuration processing and throw an error.

@@ -475,9 +472,9 @@ Unlike

--CONFIGURE-
 
 
 ENVIRONMENTÂ¶
-
+
 
-LIBMEMCACHEDÂ¶
+LIBMEMCACHEDÂ¶
 
 
 
@@ -503,9 +500,9 @@ initialized).  On an allocation failure, it returns NULL.
 
 SEE ALSOÂ¶
 
-memcached(1)
-C/C++ Client Library for memcached
-Converting Error Codes to Messages
+memcached(1)
+C/C++ Client Library for memcached
+Converting Error Codes to Messages
 
 
 
@@ -521,7 +518,7 @@ initialized).  On an allocation failure, it returns NULL.
         Next 
       
       
-         Previous
+         Previous
       
     
   
@@ -530,20 +527,11 @@ initialized).  On an allocation failure, it returns NULL.
 
   
     
-        
-        
         © Copyright 
 
     
   
-    
-    
-    
-    Built with Sphinx using a
-    
-    theme
-    
-    provided by Read the Docs. 
+  Built with Sphinx using a theme provided by Read the Docs. 
 
 
 
@@ -555,6 +543,7 @@ initialized).  On an allocation failure, it returns NULL.
   
   
 
+