svn commit: r580033 - in /mina/branches: 1.0/core/src/main/java/org/apache/mina/transport/socket/nio/SocketConnector.java 1.1/core/src/main/java/org/apache/mina/transport/socket/nio/SocketConnector.java

[trustin]

Author: trustin
Date: Thu Sep 27 07:44:15 2007
New Revision: 580033

URL: http://svn.apache.org/viewvc?rev=580033&view=rev
Log:
Added more description to get/setWorkerTimeout method in SocketConnector.java


Modified:
    
mina/branches/1.0/core/src/main/java/org/apache/mina/transport/socket/nio/SocketConnector.java
    
mina/branches/1.1/core/src/main/java/org/apache/mina/transport/socket/nio/SocketConnector.java

Modified: 
mina/branches/1.0/core/src/main/java/org/apache/mina/transport/socket/nio/SocketConnector.java
URL: 
http://svn.apache.org/viewvc/mina/branches/1.0/core/src/main/java/org/apache/mina/transport/socket/nio/SocketConnector.java?rev=580033&r1=580032&r2=580033&view=diff
==============================================================================
--- 
mina/branches/1.0/core/src/main/java/org/apache/mina/transport/socket/nio/SocketConnector.java
 (original)
+++ 
mina/branches/1.0/core/src/main/java/org/apache/mina/transport/socket/nio/SocketConnector.java
 Thu Sep 27 07:44:15 2007
@@ -114,7 +114,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;
@@ -123,7 +125,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) {
@@ -438,4 +443,4 @@
             this.config = config;
         }
     }
-}
\ No newline at end of file
+}

Modified: 
mina/branches/1.1/core/src/main/java/org/apache/mina/transport/socket/nio/SocketConnector.java
URL: 
http://svn.apache.org/viewvc/mina/branches/1.1/core/src/main/java/org/apache/mina/transport/socket/nio/SocketConnector.java?rev=580033&r1=580032&r2=580033&view=diff
==============================================================================
--- 
mina/branches/1.1/core/src/main/java/org/apache/mina/transport/socket/nio/SocketConnector.java
 (original)
+++ 
mina/branches/1.1/core/src/main/java/org/apache/mina/transport/socket/nio/SocketConnector.java
 Thu Sep 27 07:44:15 2007
@@ -109,7 +109,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;
@@ -118,7 +120,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) {
@@ -415,4 +420,4 @@
             this.config = config;
         }
     }
-}
\ No newline at end of file
+}