From patchwork Thu Dec 21 22:34:51 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Grant Erickson X-Patchwork-Id: 13502782 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 DAF2114AB5 for ; Thu, 21 Dec 2023 22:35:28 +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 0872273200 for ; Thu, 21 Dec 2023 17:35:28 -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 BE0E87322A for ; Thu, 21 Dec 2023 17:35:27 -0500 (EST) From: Grant Erickson To: connman@lists.linux.dev Subject: [PATCH v3 44/60] service: Document 'online_check_log_failure'. Date: Thu, 21 Dec 2023 14:34:51 -0800 Message-ID: <20231221223508.2365510-45-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 'online_check_log_failure' function. --- src/service.c | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/src/service.c b/src/service.c index 62edabed1b1b..b2eb00a3e774 100644 --- a/src/service.c +++ b/src/service.c @@ -3248,6 +3248,22 @@ static bool handle_online_check_success(struct connman_service *service, return reschedule; } +/** + * @brief + * Log an online check failure. + * + * This logs an online check failure for the specified network + * service IP configuration type. + * + * @param[in] service A pointer to the immutable network + * service for which to log an online + * check failure. + * @param[in] type The IP configuration type for which + * the online check failed. + * @param[in] err The error status, in the POSIX domain, + * associated with the online check failure. + * + */ static void online_check_log_failure(const struct connman_service *service, enum connman_ipconfig_type type, int err)