Merge Trond

[m6w6/libmemcached] / docs / memcached_behavior.pod

diff --git a/docs/memcached_behavior.pod b/docs/memcached_behavior.pod
index f59150f1751f5ef7265614a65eafc9a6a44f6a3e..eea908919a0bf6bfd272d457ff6c03258d5a7c58 100644 (file)
--- a/docs/memcached_behavior.pod
+++ b/docs/memcached_behavior.pod
@@ -211,13 +211,57 @@ 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.
 
 more write traffic.
 

+=item MEMCACHED_BEHAVIOR_CORK
+
+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
+report an error of some sort. This behavior also enables
+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
+if this occurs.
+
+=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.
+
+=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.
+

 =back
 
 =head1 RETURN
 =back
 
 =head1 RETURN