Merging branches.

[m6w6/libmemcached] / docs / memcached_behavior.pod

diff --git a/docs/memcached_behavior.pod b/docs/memcached_behavior.pod
index 20141907ba8f281cf34ab2567cf53b81986c8dd9..e5058de353efa627bce1a0e453cd53bb2a71f732 100755 (executable)
--- a/docs/memcached_behavior.pod
+++ b/docs/memcached_behavior.pod
@@ -40,7 +40,9 @@ memcached_behavior_set() will flush and reset all connections.
 =item MEMCACHED_BEHAVIOR_NO_BLOCK
 
 Causes libmemcached(3) to use asychronous IO. This is the fastest transport
-available.
+available for storage functions. For read operations it is currently 
+similar in performance to the non-blocking method (this is being
+looked into).
 
 =item MEMCACHED_BEHAVIOR_TCP_NODELAY
 
@@ -51,6 +53,14 @@ environments).
 
 Makes the default hashing algorithm for keys use MD5. The value can be set to either MEMCACHED_HASH_DEFAULT, MEMCACHED_HASH_MD5, MEMCACHED_HASH_CRC, MEMCACHED_HASH_FNV1_64, MEMCACHED_HASH_FNV1A_64, MEMCACHED_HASH_FNV1_32, MEMCACHED_HASH_FNV1A_32, MEMCACHED_HASH_KETAMA. The behavior for all hashes but MEMCACHED_HASH_DEFAULT is identitical to the Java driver written by Dustin Sallings.
 
+=item MEMCACHED_BEHAVIOR_DISTRIBUTION
+
+Using this you can enable different means of distributing values to servers.
+The default method is MEMCACHED_DISTRIBUTION_MODULA. You can enable
+consistent hashing by setting MEMCACHED_DISTRIBUTION_CONSISTENT. 
+Consistent hashing delivers better distribution and allows servers to be 
+added to the cluster with minimal cache losses. 
+
 =item MEMCACHED_BEHAVIOR_CACHE_LOOKUPS
 
 Memcached can cache named lookups so that DNS lookups are made only once.
@@ -59,6 +69,11 @@ Memcached can cache named lookups so that DNS lookups are made only once.
 
 Support CAS operations (this is not enabled by default at this point in the server since it imposes a slight performance penalty).
 
+=item MEMCACHED_BEHAVIOR_POLL_TIMEOUT
+
+Modify the timeout value that is used by poll(). The default value is -1. An signed int pointer must be passed to memcached_behavior_set() to change this value. For memcached_behavior_get() a signed int value will be cast and returned as the unsigned long long.
+
+
 =back
 
 =head1 RETURN