From: fhanik Date: Wed, 11 Oct 2006 19:36:55 +0000 (+0000) Subject: Documented all the receiver options X-Git-Url: https://git.internetallee.de/?a=commitdiff_plain;h=fe0907c5fea4256f748b61fd5140cb9c84137f26;p=tomcat7.0 Documented all the receiver options git-svn-id: https://svn.apache.org/repos/asf/tomcat/tc6.0.x/trunk@462913 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/java/org/apache/catalina/tribes/transport/ReceiverBase.java b/java/org/apache/catalina/tribes/transport/ReceiverBase.java index 9703bf033..9c2689571 100644 --- a/java/org/apache/catalina/tribes/transport/ReceiverBase.java +++ b/java/org/apache/catalina/tribes/transport/ReceiverBase.java @@ -58,7 +58,7 @@ public abstract class ReceiverBase implements ChannelReceiver, ListenCallback, T private long tcpSelectorTimeout = 5000; //how many times to search for an available socket private int autoBind = 10; - private int maxThreads = 15; + private int maxThreads = 6; private int minThreads = 6; private boolean tcpNoDelay = true; private boolean soKeepAlive = false; diff --git a/webapps/docs/config/cluster-receiver.xml b/webapps/docs/config/cluster-receiver.xml index b997a756a..8f17099c3 100644 --- a/webapps/docs/config/cluster-receiver.xml +++ b/webapps/docs/config/cluster-receiver.xml @@ -42,60 +42,99 @@ - - - - - - + The implementation of the receiver component. Two implementations available, + org.apache.catalina.tribes.transport.nio.NioReceiver and + org.apache.catalina.tribes.transport.bio.BioReceiver.
+ The org.apache.catalina.tribes.transport.nio.NioReceiver is the + preferred implementation - - + The address (network interface) to listen for incoming traffic. + Same as the bind address. The default value is auto and translates to + java.net.InetAddress.getLocalHost().getHostAddress(). + Possible values are true or false. + Set to true if you want the receiver to use direct bytebuffers when reading data + from the sockets. + The listen port for incoming data. The default value is 4000. + To avoid port conflicts the receiver will automatically bind to a free port within the range of + port <= bindPort <= port+autoBind + So for example, if port is 4000, and autoBind is set to 10, then the receiver will open up + a server socket on the first available port in the range 4000-4010. + + + Default value is 10. + Use this value if you wish to automatically avoid port conflicts the cluster receiver will try to open a + server socket on the port attribute port, and then work up autoBind number of times. + + + The secure listen port. This port is SSL enabled. If this attribute is omitted no SSL port is opened up. + There default value is unset, meaning there is no SSL socket available. + The value in milliseconds for the polling timeout in the NioReceiver. On older versions of the JDK + there have been bugs, that should all now be cleared out where the selector never woke up. + The default value is a very high 5000 milliseconds. + The maximum number of threads in the receiver thread pool. The default value is 6 + Adjust this value relative to the number of nodes in the cluster, the number of messages being exchanged and + the hardware you are running on. A higher value doesn't mean more effiecency, tune this value according to your + own test results. + Minimum number of threads to be created when the receiver is started up. Default value is 6 + Boolean value for the socket OOBINLINE option. Possible values are true or false. + The receiver buffer size on the receiving sockets. Value is in bytes, the default value is 43800 bytes. - - + The sending buffer size on the receiving sockets. Value is in bytes, the default value is 25188 bytes. + Boolean value for the socket SO_KEEPALIVE option. Possible values are true or false. + Boolean value to determine whether to use the SO_LINGER socket option. + Possible values are true or false. Default value is true. + Sets the SO_LINGER socket option time value. The value is in seconds. + The default value is 3 seconds. + Boolean value for the socket SO_REUSEADDR option. Possible values are true or false. + Sets the traffic class level for the socket, the value is between 0 and 255. + Different values are defined in + java.net.Socket#setTrafficClass(int). + Boolean value for the socket TCP_NODELAY option. Possible values are true or false. + The default value is true - - + Sets the SO_TIMEOUT option on the socket. The value is in milliseconds and the default value is 3000 + milliseconds. + Boolean value whether to use a shared buffer pool of cached org.apache.catalina.tribes.io.XByteBuffer + objects. If set to true, the XByteBuffer that is used to pass a message up the channel, will be recycled at the end + of the requests. This means that interceptors in the channel must not maintain a reference to the object + after the org.apache.catalina.tribes.ChannelInterceptor#messageReceived method has exited. + + - - - -