From: Grant Erickson <gerickson@nuovations.com>
To: connman@lists.linux.dev
Subject: [PATCH] Add documentation to the service default functions.
Date: Thu, 2 Nov 2023 16:43:53 -0700 [thread overview]
Message-ID: <FCE44C9C-69FC-4328-B02E-43BF5259C934@nuovations.com> (raw)
This adds documentation to the service default getter and introspection
functions.
---
src/service.c | 35 +++++++++++++++++++++++++++++++++++
1 file changed, 35 insertions(+)
diff --git a/src/service.c b/src/service.c
index 950d22cb..85f541ee 100644
--- a/src/service.c
+++ b/src/service.c
@@ -1657,6 +1657,18 @@ static void reset_stats(struct connman_service *service)
g_timer_reset(service->stats_roaming.timer);
}
+/**
+ * @brief
+ * Return the default service, if any.
+ *
+ * This attempts to return a pointer to the default service (that is,
+ * the service with the default route), if any.
+ *
+ * @returns
+ * A pointer to the mutable default service, if one exists;
+ * otherwise, null.
+ *
+ */
struct connman_service *connman_service_get_default(void)
{
struct connman_service *service;
@@ -1664,6 +1676,9 @@ struct connman_service *connman_service_get_default(void)
if (!service_list)
return NULL;
+ // Sorting is such that the default service is ALWAYS at the
+ // head of the service list, if one exists.
+
service = service_list->data;
if (!is_connected(service->state))
@@ -1672,6 +1687,26 @@ struct connman_service *connman_service_get_default(void)
return service;
}
+/**
+ * @brief
+ * Determine whether the specified network interface index belongs
+ * to the default service.
+ *
+ * This determines whether or not the specified network interface
+ * index belongs to the default service (that is, the service with
+ * the default route).
+ *
+ * @param[in] index The network interface to determine whether it
+ * belongs to the default service.
+ *
+ * @returns
+ * True if the specified index belongs to the default service;
+ * otherwise, false.
+ *
+ * @sa connman_service_get_default
+ * @sa __connman_service_get_index
+ *
+ */
bool __connman_service_index_is_default(int index)
{
struct connman_service *service;
--
2.42.0
next reply other threads:[~2023-11-02 23:43 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-11-02 23:43 Grant Erickson [this message]
2023-11-07 16:08 ` [PATCH] Add documentation to the service default functions Marcel Holtmann
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=FCE44C9C-69FC-4328-B02E-43BF5259C934@nuovations.com \
--to=gerickson@nuovations.com \
--cc=connman@lists.linux.dev \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).