Notes on keep-alive
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/net/trunk@1786589 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/main/java/org/apache/commons/net/ftp/FTPClient.java b/src/main/java/org/apache/commons/net/ftp/FTPClient.java
index d6bf6fa..7178677 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPClient.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPClient.java
@@ -276,7 +276,9 @@
* The implementation currently uses a {@link CopyStreamListener} which is passed to the
* {@link Util#copyStream(InputStream, OutputStream, int, long, CopyStreamListener, boolean)}
* method, so the timing is partially dependent on how long each block transfer takes.
- *
+ * <p>
+ * <b>This keep-alive feature is optional; if it does not help or causes problems then don't use it.</b>
+ * <p>
* @see #FTP_SYSTEM_TYPE
* @see #SYSTEM_TYPE_PROPERTIES
* @see FTP
@@ -3735,6 +3737,8 @@
/**
* Set the time to wait between sending control connection keepalive messages
* when processing file upload or download.
+ * <p>
+ * See the class Javadoc section "Control channel keep-alive feature:"
*
* @param controlIdle the wait (in secs) between keepalive messages. Zero (or less) disables.
* @since 3.0
@@ -3745,7 +3749,11 @@
}
/**
- * Get the time to wait between sending control connection keepalive messages.
+ * Get the time to wait between sending control connection keepalive messages
+ * when processing file upload or download.
+ * <p>
+ * See the class Javadoc section "Control channel keep-alive feature:"
+ *
* @return the number of seconds between keepalive messages.
* @since 3.0
*/
