aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGrant Erickson <gerickson@nuovations.com>2023-12-21 14:34:39 -0800
committerMarcel Holtmann <marcel@holtmann.org>2023-12-23 13:19:19 +0100
commit19abfb9c37ab5d5b964d5ee8899196b0f9858704 (patch)
treebfdcb017d5a0ef556a824587348ce505cdefe56d
parent8a52b1186c34f3d4b3ff18c904a0f8b9430b0166 (diff)
downloadconnman-19abfb9c37ab5d5b964d5ee8899196b0f9858704.tar.gz
service: Document 'online_check_{failures,successes}_reset'.
This adds documentation to the 'online_check_{failures,successes}_reset' functions.
-rw-r--r--src/service.c24
1 files changed, 24 insertions, 0 deletions
diff --git a/src/service.c b/src/service.c
index 8a1d09f1a..810ff68cf 100644
--- a/src/service.c
+++ b/src/service.c
@@ -2266,6 +2266,18 @@ static inline void online_check_counter_reset(
*counter = 0;
}
+/**
+ * @brief
+ * Reset to zero (0) the IPv4 and IPv6 online check failure
+ * counters for the specified service.
+ *
+ * @param[in] service A pointer to the mutable service for which
+ * to reset the IPv4 and IPv6 online check
+ * failure counters.
+ *
+ * @sa online_check_successes_reset
+ *
+ */
static void online_check_failures_reset(struct connman_service *service)
{
DBG("service %p (%s)",
@@ -2275,6 +2287,18 @@ static void online_check_failures_reset(struct connman_service *service)
online_check_counter_reset(&service->online_check_state_ipv6.failures);
}
+/**
+ * @brief
+ * Reset to zero (0) the IPv4 and IPv6 online check success
+ * counters for the specified service.
+ *
+ * @param[in] service A pointer to the mutable service for which
+ * to reset the IPv4 and IPv6 online check
+ * success counters.
+ *
+ * @sa online_check_failures_reset
+ *
+ */
static void online_check_successes_reset(struct connman_service *service)
{
DBG("service %p (%s)",