doc: Document the 'OnlineCheck{Failures,Successes}Threshold' settings.

This documents the 'OnlineCheck{Failures,Successes}Threshold' settings.

2 files changed, 76 insertions, 0 deletions

diff --git a/doc/connman.conf.5.in b/doc/connman.conf.5.in
index 9049d7037..bc5a112f7 100644
--- a/doc/connman.conf.5.in
+++ b/doc/connman.conf.5.in
@@ -222,6 +222,44 @@ will transition to READY state, enabling another service to become the
 default one, in replacement.
 Default value is false.
 .TP
+.BI OnlineCheckFailuresThreshold= failures
+When both \fBEnableOnlineCheck\fR and
+\fBEnableOnlineToReadyTransition\fR are asserted, this is the number
+of failed back-to-back "ready" to "online" HTTP-based Internet
+reachability checks that will be allowed before marking a service as
+"failed" from a reachability perspective, sorting it at a lower
+priority than other services not so marked.
+
+Lower values may result in higher-frequency network service cycling
+while higher values may result in a longer period of time before
+failing from a non-Internet reachable service to one that might be.
+
+See \fBOnlineCheckIntervalStyle\fR, \fBOnlineCheckInitialInterval\fR,
+and \fBOnlineCheckMaxInterval\fR for other values that influence
+network service failure/recovery transition time.
+
+The default value is 6.
+.TP
+.BI OnlineCheckSuccessesThreshold= successes
+When both \fBEnableOnlineCheck\fR and
+\fBEnableOnlineToReadyTransition\fR are asserted, this is the number
+of successful back-to-back "ready" to "online" HTTP-based Internet
+reachability checks that must be met before clearing a service as
+"failed" from a reachability perspective and allowing it to transition
+to the "online" state again, allowing it to sort back to a higher
+priority relative to other network services.
+
+Lower values may result in higher-frequency network service cycling
+while higher values may result in a longer period of time before
+transitioning back to more a preferred, Internet reachable network
+service.
+
+See \fBOnlineCheckIntervalStyle\fR, \fBOnlineCheckInitialInterval\fR,
+and \fBOnlineCheckMaxInterval\fR for other values that influence
+network service failure/recovery transition time.
+
+The default value is 6.
+.TP
 .BI AutoConnectRoamingServices=true\ \fR|\fB\ false
 Automatically connect roaming services. This is not recommended unless you know
 you won't have any billing problem.
diff --git a/src/main.conf b/src/main.conf
index ddcb3564c..b0eb93811 100644
--- a/src/main.conf
+++ b/src/main.conf
@@ -159,6 +159,44 @@
 # default one, in replacement.
 # EnableOnlineToReadyTransition = false
 
+# When both "EnableOnlineCheck" and "EnableOnlineToReadyTransition"
+# are asserted, this is the number of failed back-to-back "ready" to
+# "online" HTTP-based Internet reachability checks that will be
+# allowed before marking a service as "failed" from a reachability
+# perspective, sorting it at a lower priority than other services not
+# so marked.
+#
+# Lower values may result in higher-frequency network service cycling
+# while higher values may result in a longer period of time before
+# failing from a non-Internet reachable service to one that might be.
+#
+# See "OnlineCheckIntervalStyle", "OnlineCheckInitialInterval", and
+# "OnlineCheckMaxInterval" for other values that influence network
+# service failure/recovery transition time.
+#
+# Default value is 6.
+# OnlineCheckFailuresThreshold=6
+
+# When both "EnableOnlineCheck" and "EnableOnlineToReadyTransition"
+# are asserted, this is the number of successful back-to-back "ready"
+# to "online" HTTP-based Internet reachability checks that must be met
+# before clearing a service as "failed" from a reachability
+# perspective and allowing it to transition to the "online" state
+# again, allowing it to sort back to a higher priority relative to
+# other network services.
+#
+# Lower values may result in higher-frequency network service cycling
+# while higher values may result in a longer period of time before
+# transitioning back to more a preferred, Internet reachable network
+# service.
+#
+# See "OnlineCheckIntervalStyle", "OnlineCheckInitialInterval", and
+# "OnlineCheckMaxInterval" for other values that influence network
+# service failure/recovery transition time.
+#
+# Default value is 6.
+# OnlineCheckSuccessesThreshold=6
+
 # The style or mathematical series function used to compute the actual
 # time, in seconds, between two "ready" to "online" HTTP-based Internet
 # reachability checks. The value of which may be either "geometric" or