From patchwork Thu Dec 21 06:39:47 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Grant Erickson X-Patchwork-Id: 13501219 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 31A21B678 for ; Thu, 21 Dec 2023 06:40:26 +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 96EFA73242 for ; Thu, 21 Dec 2023 01:40:25 -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 5A0B373276 for ; Thu, 21 Dec 2023 01:40:25 -0500 (EST) From: Grant Erickson To: connman@lists.linux.dev Subject: [PATCH v2 43/60] service: Document 'handle_{continuous,oneshot}_online_check_success'. Date: Wed, 20 Dec 2023 22:39:47 -0800 Message-ID: <20231221064007.2347566-44-gerickson@nuovations.com> X-Mailer: git-send-email 2.42.0 In-Reply-To: <20231221064007.2347566-1-gerickson@nuovations.com> References: <20231221064007.2347566-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 'handle_{continuous,oneshot}_online_check_success' functions. --- src/service.c | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) diff --git a/src/service.c b/src/service.c index 1e2282572892..62edabed1b1b 100644 --- a/src/service.c +++ b/src/service.c @@ -2998,6 +2998,36 @@ static void continuous_online_check_log_failures_threshold_met( counter_description); } +/** + * @brief + * Handle the successful completion of an "online" HTTP-based + * Internet reachability check for the specified network service + * and IP configuration type for the "one-shot" online check mode. + * + * This handles the completion of a successful "online" HTTP-based + * Internet reachability check for the specified network service and + * IP configuration type for the "one-shot" online check mode. This + * effectively "bookends" an earlier #__connman_service_wispr_start. + * + * @param[in,out] service A pointer to the mutable service + * for which to handle a + * successful previously-requested + * online check. + * @param[in] type The IP configuration type for + * which to handle a successful + * previously-requested online + * check. + * @param[in,out] online_check_state A pointer to the online check + * state for @a service + * associated with @a type. + * + * @returns + * False, unconditionally. + * + * @sa handle_oneshot_online_check_failure + * @sa handle_online_check_success + * + */ static bool handle_oneshot_online_check_success( struct connman_service *service, enum connman_ipconfig_type type, @@ -3018,6 +3048,37 @@ static bool handle_oneshot_online_check_success( return !reschedule; } +/** + * @brief + * Handle the successful completion of an "online" HTTP-based + * Internet reachability check for the specified network service + * and IP configuration type for the "continuous" online check mode. + * + * This handles the completion of a successful "online" HTTP-based + * Internet reachability check for the specified network service and + * IP configuration type for the "continuous" online check mode. This + * effectively "bookends" an earlier #__connman_service_wispr_start. + * + * @param[in,out] service A pointer to the mutable service + * for which to handle a + * successful previously-requested + * online check. + * @param[in] type The IP configuration type for + * which to handle a successful + * previously-requested online + * check. + * @param[in,out] online_check_state A pointer to the online check + * state for @a service + * associated with @a type. + * + * @returns + * True if another online check should be scheduled; otherwise, + * false. + * + * @sa handle_continuous_online_check_failure + * @sa handle_online_check_success + * + */ static bool handle_continuous_online_check_success( struct connman_service *service, enum connman_ipconfig_type type,