You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2023/06/30 11:38:13 UTC
[commons-net] branch master updated: [NET-722] Javadoc for FtpClient.setControlKeepAliveReplyTimeout(Duration) says timeout is in milliseconds
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-net.git
The following commit(s) were added to refs/heads/master by this push:
new 67932a7e [NET-722] Javadoc for FtpClient.setControlKeepAliveReplyTimeout(Duration) says timeout is in milliseconds
new 1f18a03a Merge branch 'master' of https://gitbox.apache.org/repos/asf/commons-net.git
67932a7e is described below
commit 67932a7e50535e9ecbd6ad3f5f3cc4ce75e043ee
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Fri Jun 30 07:37:52 2023 -0400
[NET-722] Javadoc for
FtpClient.setControlKeepAliveReplyTimeout(Duration) says timeout is in
milliseconds
More Javadoc tweaks
---
src/changes/changes.xml | 5 ++++-
src/main/java/org/apache/commons/net/ftp/FTPClient.java | 14 +++++++-------
2 files changed, 11 insertions(+), 8 deletions(-)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 38cd32b1..72c79fa1 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -123,7 +123,10 @@ The <action> type attribute can be add,update,fix,remove.
</action>
<action type="fix" dev="ggregory" due-to="step-security-bot, Gary Gregory">
[StepSecurity] ci: Harden GitHub Actions #156.
- </action>
+ </action>
+ <action type="fix" dev="ggregory" due-to="David Costanzo, Gary Gregory" issue="NET-722">
+ Javadoc for FtpClient.setControlKeepAliveReplyTimeout(Duration) says timeout is in milliseconds.
+ </action>
<!-- UPDATE -->
<action type="update" dev="ggregory" due-to="Dependabot">
Bump commons-parent from 54 to 58 #132, #137, #153.
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 9decbc59..844a7b80 100644
--- a/src/main/java/org/apache/commons/net/ftp/FTPClient.java
+++ b/src/main/java/org/apache/commons/net/ftp/FTPClient.java
@@ -2913,9 +2913,9 @@ public class FTPClient extends FTP implements Configurable {
}
/**
- * Sets how long to wait for control keep-alive message replies.
+ * Sets the duration to wait for control keep-alive message replies.
*
- * @param timeout number of milliseconds to wait (defaults to 1000)
+ * @param timeout duration to wait (defaults to 1000)
* @since 3.0
* @see #setControlKeepAliveTimeout(Duration)
*/
@@ -2924,7 +2924,7 @@ public class FTPClient extends FTP implements Configurable {
}
/**
- * Sets how long to wait for control keep-alive message replies.
+ * Sets the duration to wait for control keep-alive message replies.
*
* @deprecated Use {@link #setControlKeepAliveReplyTimeout(Duration)}.
* @param timeoutMillis number of milliseconds to wait (defaults to 1000)
@@ -2937,12 +2937,12 @@ public class FTPClient extends FTP implements Configurable {
}
/**
- * Sets the time to wait between sending control connection keepalive messages when processing file upload or download.
+ * Sets the duration 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"
* </p>
*
- * @param controlIdle the wait between keepalive messages. Zero (or less) disables.
+ * @param controlIdle the duration to wait between keepalive messages. Zero (or less) disables.
* @since 3.9.0
* @see #setControlKeepAliveReplyTimeout(Duration)
*/
@@ -2951,13 +2951,13 @@ public class FTPClient extends FTP implements Configurable {
}
/**
- * Sets the time to wait between sending control connection keepalive messages when processing file upload or download.
+ * Sets the duration 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"
* </p>
*
* @deprecated Use {@link #setControlKeepAliveTimeout(Duration)}.
- * @param controlIdleSeconds the wait (in seconds) between keepalive messages. Zero (or less) disables.
+ * @param controlIdleSeconds the wait in seconds between keepalive messages. Zero (or less) disables.
* @since 3.0
* @see #setControlKeepAliveReplyTimeout(int)
*/