Author: chirino
Date: Thu Apr 12 13:06:01 2012
New Revision: 1325239
URL: http://svn.apache.org/viewvc?rev=1325239&view=rev
Log:
Better documents how to configure socket options. Fixes APLO-190 : Add support for socket
level tuning
Modified:
activemq/activemq-apollo/trunk/apollo-website/src/documentation/user-manual.md
Modified: activemq/activemq-apollo/trunk/apollo-website/src/documentation/user-manual.md
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-website/src/documentation/user-manual.md?rev=1325239&r1=1325238&r2=1325239&view=diff
==============================================================================
--- activemq/activemq-apollo/trunk/apollo-website/src/documentation/user-manual.md (original)
+++ activemq/activemq-apollo/trunk/apollo-website/src/documentation/user-manual.md Thu Apr
12 13:06:01 2012
@@ -184,18 +184,20 @@ and port to determine to which local int
The TCP URI also supports several query parameters to fine tune the
settings used on the socket. The supported parameters are:
+* `backlog` : Sets the listen backlog size. Defaults to 100.
+
* `receive_buffer_size` : Sets the size of the internal socket receive
- buffer. Defaults to 65536 (64k)
+ buffer (aka setting the socket's SO_RCVBUF). Defaults to 65536 (64k)
-* `send_buffer_size` : Sets the size of the internal socket send buffer.
- Defaults to 65536 (64k)
+* `send_buffer_size` : Sets the size of the internal socket send buffer
+ (aka setting the socket's SO_SNDBUF). Defaults to 65536 (64k)
-* `keep_alive` : Enable or disable the SO_KEEPALIVE socket option.
- Defaults to true.
+* `keep_alive` : Enable or disable the SO_KEEPALIVE socket option
+ (aka setting the socket's SO_KEEPALIVE). Defaults to true.
* `traffic_class` : Sets traffic class or type-of-service octet in the IP
- header for packets sent from the transport. Defaults to `8` which
- means the traffic should be optimized for throughput.
+ header for packets sent from the transport (aka setting the socket's IP_TOS).
+ Defaults to `8` which means the traffic should be optimized for throughput.
* `max_read_rate` : Sets the maximum bytes per second that this transport will
receive data at. This setting throttles reads so that the rate is not exceeded.
|