diff options
author | Grant Erickson <gerickson@nuovations.com> | 2023-12-21 14:34:43 -0800 |
---|---|---|
committer | Marcel Holtmann <marcel@holtmann.org> | 2023-12-23 13:19:19 +0100 |
commit | 29d9e1897ae675dd3915c5d014c7071fb074c7a3 (patch) | |
tree | 13ba21af3ffa85f34e58932016abd23bcb8e2ec8 | |
parent | efb67730fee1f91c34288d50c683fd5055d19a6c (diff) | |
download | connman-29d9e1897ae675dd3915c5d014c7071fb074c7a3.tar.gz |
service: Document 'is_online_check_failure_threshold_met_predicate'.
This adds documentation to the
'is_online_check_failure_threshold_met_predicate' function.
-rw-r--r-- | src/service.c | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/src/service.c b/src/service.c index abf7800b5..8c8ff1c7a 100644 --- a/src/service.c +++ b/src/service.c @@ -2437,6 +2437,32 @@ done: return threshold_met; } +/** + * @brief + * Determine whether the service has met the online check failure + * threshold. + * + * This predicate determines whether the online check failure + * threshold has been met by the specified network service. + * + * @param[in] service A pointer to the immutable + * network service for which to + * check whether its has met the + * online check failure threshold. + * @param[in] counter_description A pointer to a null-terminated + * C string describing the failure + * counter. For example, + * "failure". + * @param[in] counter_threshold The threshold value to check the + * failure counter against. + * + * @returns + * True if the online check failure counter has met the failure + * threshold; otherwise, false. + * + * @sa online_check_failures_threshold_is_met + * + */ static bool is_online_check_failure_threshold_met_predicate( const struct connman_service *service, const char *counter_description, |