enh: Wording fixes in various messages, document --rcv-timeout in man…

…page. Follow-up to esnet#1123. Pet copyrights where appropriate.
hanvari · Jul 3, 2021 · 23ca534 · 23ca534
1 parent 5603721
commit 23ca534
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 8 deletions.
diff --git a/src/iperf3.1 b/src/iperf3.1
@@ -171,6 +171,11 @@ timestamps, see
 If this optional format is given, the \fC=\fR must immediately
 follow the \fB--timestamps\fR option with no whitespace intervening.
 .TP
+.BR --rcv-timeout " \fI#\fR"
+set idle timeout for receiving data during active tests. The receiver
+will halt a test if no data is received from the sender for this
+number of ms (default to 12000 ms, or 2 minutes).
+.TP
 .BR -d ", " --debug " "
 emit debugging output.
 Primarily (perhaps exclusively) of use to developers.

diff --git a/src/iperf_error.c b/src/iperf_error.c
@@ -1,5 +1,5 @@
 /*
- * iperf, Copyright (c) 2014-2020, The Regents of the University of
+ * iperf, Copyright (c) 2014-2021, The Regents of the University of
  * California, through Lawrence Berkeley National Laboratory (subject
  * to receipt of any required approvals from the U.S. Dept. of
  * Energy).  All rights reserved.
@@ -439,7 +439,7 @@ iperf_strerror(int int_errno)
 	    snprintf(errstr, len, "idle timeout parameter is not positive or larget then allowed limit");
             break;
 	case IENOMSG:
-	    snprintf(errstr, len, "message receiving timedout");
+	    snprintf(errstr, len, "idle timeout for receiving data");
             break;
     case IESETDONTFRAGMENT:
 	    snprintf(errstr, len, "unable to set IP Do-Not-Fragment flag");

diff --git a/src/iperf_locale.c b/src/iperf_locale.c
@@ -1,5 +1,5 @@
 /*--------------------------------------------------------------- 
- * iperf, Copyright (c) 2014-2020, The Regents of the University of
+ * iperf, Copyright (c) 2014-2021, The Regents of the University of
  * California, through Lawrence Berkeley National Laboratory (subject
  * to receipt of any required approvals from the U.S. Dept. of
  * Energy).  All rights reserved.
@@ -116,20 +116,20 @@ const char usage_longstr[] = "Usage: iperf3 [-s|-c host] [options]\n"
                            "  --timestamps<=format>     emit a timestamp at the start of each output line\n"
                            "                            (optional \"=\" and format string as per strftime(3))\n"
 
+                           "  --rcv-timeout #           idle timeout for receiving data\n"
+                           "                            (default %d ms)\n"
                            "  -d, --debug               emit debugging output\n"
                            "  -v, --version             show version information and quit\n"
                            "  -h, --help                show this message and quit\n"
-                           "  --rcv-timeout #           timeout for receiving a message in active mode (ms)\n"
-                           "                            on receving side.  Default is %d\n"
                            "Server specific:\n"
                            "  -s, --server              run in server mode\n"
                            "  -D, --daemon              run the server as a daemon\n"
                            "  -1, --one-off             handle one client connection then exit\n"
 			   "  --server-bitrate-limit #[KMG][/#]   server's total bit rate limit (default 0 = no limit)\n"
 			   "                            (optional slash and number of secs interval for averaging\n"
 			   "                            total data rate.  Default is 5 seconds)\n"
-                           "  --idle-timeout #          restart server if is idle for #[sec] to overcome stacked\n"
-                           "                            server for different reasone (default - no timeout)\n"
+                           "  --idle-timeout #          restart idle server after # seconds in case it\n"
+                           "                            got stuck (default - no timeout)\n"
 #if defined(HAVE_SSL)
                            "  --rsa-private-key-path    path to the RSA private key used to decrypt\n"
 			   "                            authentication credentials\n"

diff --git a/src/iperf_server_api.c b/src/iperf_server_api.c
@@ -527,7 +527,7 @@ iperf_run_server(struct iperf_test *test)
                     test->server_forced_no_msg_restarts_count += 1;
                     i_errno = IENOMSG;
                     if (iperf_get_verbose(test))
-                        iperf_err(test, "Server restart (#%d) in active test as message receive timed-out",
+                        iperf_err(test, "Server restart (#%d) during active test due to idle data for receiving data",
                                   test->server_forced_no_msg_restarts_count);
                     cleanup_server(test);
                     return -1;