diff options
| author | Grant Erickson <gerickson@nuovations.com> | 2023-12-21 14:34:42 -0800 |
|---|---|---|
| committer | Marcel Holtmann <marcel@holtmann.org> | 2023-12-23 13:19:19 +0100 |
| commit | efb67730fee1f91c34288d50c683fd5055d19a6c (patch) | |
| tree | 6416a3a6554f7c2a5b39681afba43b657548cae6 | |
| parent | 8820a7c91cf8454e32e312305e111f0de23579d8 (diff) | |
| download | connman-efb67730fee1f91c34288d50c683fd5055d19a6c.tar.gz | |
service: Document 'online_check_counter_threshold_is_met'.
This adds documentation to the 'online_check_counter_threshold_is_met'
function.
| -rw-r--r-- | src/service.c | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/src/service.c b/src/service.c index e6652f533..abf7800b5 100644 --- a/src/service.c +++ b/src/service.c @@ -2373,6 +2373,38 @@ static void online_check_counters_log( ipv6_counter); } +/** + * @brief + * Determine whether an online check counter has met its threshold. + * + * This determines whether an online check counter associated with + * the specified network service has met its threshold, where the + * threshold is accessed from the configuration store with the + * specified key. + * + * @param[in] service A pointer to the immutable + * network service associated with + * the counter to check. + * @param[in] counter_threshold_key A pointer to a null-terminated + * C string containing the key to + * use with the configuration + * store to access the threshold + * value to check the counter + * against. + * @param[in] counter_description A pointer to a null-terminated + * C string describing the counter + * to check. For example, "failure". + * @param[in] predicate A pointer to the predicate + * function to invoke to make the + * actual determination of whether + * the counter has met the + * threshold accessed by @a + * counter_threshold_key. + * + * @returns + * True if the counter has met the threshold; otherwise, false. + * + */ static bool online_check_counter_threshold_is_met( const struct connman_service *service, const char *counter_threshold_key, |