Merge in additions to the scanner.

[awesomized/libmemcached] / docs / memcached_behavior.pod

diff --git a/docs/memcached_behavior.pod b/docs/memcached_behavior.pod
index 2e0240afbe4c0c88a9463e22267739dc79f3543e..02ab0de410df9f1193e142e79f24310b75d7f40b 100644 (file)
--- a/docs/memcached_behavior.pod
+++ b/docs/memcached_behavior.pod
@@ -211,11 +211,11 @@ other objects (on the 'n' next servers specified in your server list).
 
 =item MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ
 
 
 =item MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ
 

-Allows randomizing the replica reads starting point. Normally the read is 
+Allows randomizing the replica reads starting point. Normally the read is

 done from primary server and in case of miss the read is done from primary
 done from primary server and in case of miss the read is done from primary

-+ 1, then primary + 2 all the way to 'n' replicas. If this option is set 
++ 1, then primary + 2 all the way to 'n' replicas. If this option is set

 on the starting point of the replica reads is randomized between the servers.
 on the starting point of the replica reads is randomized between the servers.

-This allows distributing read load to multiple servers with the expense of 
+This allows distributing read load to multiple servers with the expense of

 more write traffic.
 
 =item MEMCACHED_BEHAVIOR_CORK
 more write traffic.
 
 =item MEMCACHED_BEHAVIOR_CORK


@@ -224,21 +224,48 @@ Enable TCP_CORK behavior. This is only available as an option Linux.
 MEMCACHED_NO_SERVERS is returned if no servers are available to test with.
 MEMCACHED_NOT_SUPPORTED is returned if we were not able to determine
 if support was available. All other responses then MEMCACHED_SUCCESS
 MEMCACHED_NO_SERVERS is returned if no servers are available to test with.
 MEMCACHED_NOT_SUPPORTED is returned if we were not able to determine
 if support was available. All other responses then MEMCACHED_SUCCESS

-report an error of some sort. This behavior also enables 
+report an error of some sort. This behavior also enables

 MEMCACHED_BEHAVIOR_TCP_NODELAY when set.
 
 MEMCACHED_BEHAVIOR_TCP_NODELAY when set.
 

+=item MEMCACHED_BEHAVIOR_KEEPALIVE
+
+Enable TCP_KEEPALIVE behavior.
+
+=item MEMCACHED_BEHAVIOR_KEEPALIVE_IDLE
+
+Specify time, in seconds, to mark a connection as idle. This is only available as an option Linux.

 
 =item MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
 
 Find the current size of SO_SNDBUF. A value of 0 means either an error
 occured or no hosts were available. It is safe to assume system default
 
 =item MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
 
 Find the current size of SO_SNDBUF. A value of 0 means either an error
 occured or no hosts were available. It is safe to assume system default

-if this occurs.
+if this occurs. If an error occurs you can checked the last cached errno statement to find the specific error.

 
 =item MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
 
 Find the current size of SO_RCVBUF. A value of 0 means either an error
 occured or no hosts were available. It is safe to assume system default
 
 =item MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
 
 Find the current size of SO_RCVBUF. A value of 0 means either an error
 occured or no hosts were available. It is safe to assume system default

-if this occurs.
+if this occurs. If an error occurs you can checked the last cached errno statement to find the specific error.
+
+=item MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
+
+This number of times a host can have an error before it is disabled.
+
+=item MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS
+
+If enabled any hosts which have been flagged as disabled will be removed
+from the list of servers in the memcached_st structure. This must be used
+in combination with MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT.
+
+=item MEMCACHED_BEHAVIOR_RETRY_TIMEOUT
+
+When enabled a host which is problematic will only be checked for usage
+based on the amount of time set by this behavior.
+
+=item MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY
+
+When enabled the prefix key will be added to the key when determining
+server by hash.

 
 =back
 
 
 =back