[v3,48/60] service: Document interval assignment in '__connman_service_wispr_start'.

Commit Message

Grant Erickson Dec. 21, 2023, 10:34 p.m. UTC

This adds a comment documenting the rationale for setting the check
interval to the initial interval in '__connman_service_wispr_start'.
---
 src/service.c | 5 +++++
 1 file changed, 5 insertions(+)

Patch

diff --git a/src/service.c b/src/service.c
index b1fb6a3e532a..cae4258fca7f 100644
--- a/src/service.c
+++ b/src/service.c
@@ -3832,6 +3832,11 @@  int __connman_service_wispr_start(struct connman_service *service,
 	if (online_check_is_active(service, type))
 		return -EALREADY;
 
+	/*
+	 * At this particular entry point, we assume to be starting an
+	 * "online" HTTP-based Internet reachability check
+	 * afresh. Consequently, set the check interval to initial.
+	 */
 	if (type == CONNMAN_IPCONFIG_TYPE_IPV4)
 		service->online_check_state_ipv4.interval =
 					online_check_initial_interval;