Author: trustin
Date: Thu Sep 27 07:46:24 2007
New Revision: 580035
URL: http://svn.apache.org/viewvc?rev=580035&view=rev
Log:
Related issue: DIRMINA-443
* Added better description on workerTimeout property in SocketConnector
Modified:
mina/trunk/core/src/main/java/org/apache/mina/transport/socket/nio/NioSocketConnector.java
Modified:
mina/trunk/core/src/main/java/org/apache/mina/transport/socket/nio/NioSocketConnector.java
URL:
http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/transport/socket/nio/NioSocketConnector.java?rev=580035&r1=580034&r2=580035&view=diff
==============================================================================
---
mina/trunk/core/src/main/java/org/apache/mina/transport/socket/nio/NioSocketConnector.java
(original)
+++
mina/trunk/core/src/main/java/org/apache/mina/transport/socket/nio/NioSocketConnector.java
Thu Sep 27 07:46:24 2007
@@ -137,7 +137,9 @@
/**
* How many seconds to keep the connection thread alive between connection
requests
*
- * @return Number of seconds to keep connection thread alive
+ * @return the number of seconds to keep connection thread alive.
+ * 0 means that the connection thread will terminate immediately
+ * when there's no connection to make.
*/
public int getWorkerTimeout() {
return workerTimeout;
@@ -146,7 +148,10 @@
/**
* Set how many seconds the connection worker thread should remain alive
once idle before terminating itself.
*
- * @param workerTimeout Number of seconds to keep thread alive. Must be >=0
+ * @param workerTimeout the number of seconds to keep thread alive.
+ * Must be >=0. If 0 is specified, the connection
+ * worker thread will terminate immediately when
+ * there's no connection to make.
*/
public void setWorkerTimeout(int workerTimeout) {
if (workerTimeout < 0) {
