[7/8] Add documentation for 'OnlineCheckConnectTimeout'.

Commit Message

Grant Erickson Nov. 11, 2023, 7 p.m. UTC

This adds documentation for the 'OnlineCheckConnectTimeout' configuration
key.
---
 doc/connman.conf.5.in | 9 +++++++++
 src/main.conf         | 9 +++++++++
 2 files changed, 18 insertions(+)

Patch

diff --git a/doc/connman.conf.5.in b/doc/connman.conf.5.in
index 75669abc5bcd..9049d7037623 100644
--- a/doc/connman.conf.5.in
+++ b/doc/connman.conf.5.in
@@ -174,6 +174,15 @@  Please refer to the README for more detailed information.
 Default values are http://ipv4.connman.net/online/status.html and
 http://ipv6.connman.net/online/status.html respectively.
 .TP
+.BI OnlineCheckConnectTimeout= secs[.milliseconds]
+The time, in decimal seconds (for example, 12.3), to wait for a
+successful TCP connection to the host associated with
+\fBOnlineCheckIPv4URL\fR or \fBOnlineCheckIPv6URL\fR (see above). Connections
+that take longer than \fBOnlineCheckConnectTimeout\fR will be aborted. The
+default value is zero ('0') which indicates that no explicit
+connection timeout will be used, leaving the timeout to the underlying
+operating system and network stack.
+.TP
 .BI OnlineCheckInitialInterval= secs, OnlineCheckMaxInterval= secs
 Range of intervals between two online check requests.
 Please refer to the README for more detailed information.
diff --git a/src/main.conf b/src/main.conf
index ef1939cf5b6f..ddcb3564c246 100644
--- a/src/main.conf
+++ b/src/main.conf
@@ -132,6 +132,15 @@ 
 # OnlineCheckIPv4URL= http://ipv4.connman.net/online/status.html
 # OnlineCheckIPv6URL= http://ipv6.connman.net/online/status.html
 
+# The time, in decimal seconds (for example, 12.3), to wait for a
+# successful TCP connection to the host associated with
+# "OnlineCheckIPv4URL" or "OnlineCheckIPv6URL". Connections that take
+# longer than "OnlineCheckConnectTimeout" will be aborted. The default
+# value is zero ('0') which indicates that no explicit connection
+# timeout will be used, leaving the timeout to the underlying operating
+# system and network stack.
+# OnlineCheckConnectTimeout=0
+
 # Range of intervals between two online check requests.
 # Please refer to the README for more detailed information.
 # Default values are 1 and 12 respectively.