From patchwork Thu Dec 21 22:34:43 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Grant Erickson X-Patchwork-Id: 13502774 Received: from mohas.pair.com (mohas.pair.com [209.68.5.112]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 5BBF31E4A2 for ; Thu, 21 Dec 2023 22:35:25 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=nuovations.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=nuovations.com Received: from mohas.pair.com (localhost [127.0.0.1]) by mohas.pair.com (Postfix) with ESMTP id C182873207 for ; Thu, 21 Dec 2023 17:35:24 -0500 (EST) Received: from localhost.localdomain (unknown [IPv6:2601:647:5a00:15c1:f5ab:4a5e:2861:14b3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mohas.pair.com (Postfix) with ESMTPSA id 830C773225 for ; Thu, 21 Dec 2023 17:35:24 -0500 (EST) From: Grant Erickson To: connman@lists.linux.dev Subject: [PATCH v3 36/60] service: Document 'is_online_check_failure_threshold_met_predicate'. Date: Thu, 21 Dec 2023 14:34:43 -0800 Message-ID: <20231221223508.2365510-37-gerickson@nuovations.com> X-Mailer: git-send-email 2.42.0 In-Reply-To: <20231221223508.2365510-1-gerickson@nuovations.com> References: <20231221223508.2365510-1-gerickson@nuovations.com> Precedence: bulk X-Mailing-List: connman@lists.linux.dev List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-Scanned-By: mailmunge 3.11 on 209.68.5.112 This adds documentation to the 'is_online_check_failure_threshold_met_predicate' function. --- src/service.c | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/src/service.c b/src/service.c index abf7800b56fa..8c8ff1c7a496 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,