ConnMan network manager
 help / color / mirror / Atom feed
From: Grant Erickson <gerickson@nuovations.com>
To: connman@lists.linux.dev
Subject: [PATCH 02/90] connection: Document 'find_any_active_gateway_data'.
Date: Wed,  6 Dec 2023 15:49:25 -0800	[thread overview]
Message-ID: <20231206235056.322578-3-gerickson@nuovations.com> (raw)
In-Reply-To: <20231206235056.322578-1-gerickson@nuovations.com>

From: Grant Erickson <erick205@umn.edu>

This adds documentation to the 'find_any_active_gateway_data'
function.
---
 src/connection.c | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/src/connection.c b/src/connection.c
index f0da0c3c442c..6be39a773df1 100644
--- a/src/connection.c
+++ b/src/connection.c
@@ -352,6 +352,21 @@ static struct gateway_data *find_gateway_data(
 	return NULL;
 }
 
+/**
+ *  @brief
+ *    Find the first, or any, gateway data marked active.
+ *
+ *  This attempts to find the first, or any, gateway data marked
+ *  active.
+ *
+ *  @returns
+ *    A pointer to the first, or any, gateway data marked active on
+ *    success; otherwise, null.
+ *
+ *  @sa find_default_gateway_data
+ *  @sa find_gateway_data
+ *
+ */
 static struct gateway_data *find_any_active_gateway_data(void)
 {
 	GHashTableIter iter;
-- 
2.42.0


  parent reply	other threads:[~2023-12-06 23:50 UTC|newest]

Thread overview: 94+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-12-06 23:49 [PATCH 00/90] Add Gateway Low-priority Default Routes for Non-default Services Grant Erickson
2023-12-06 23:49 ` [PATCH 01/90] connection: Rename 'find_active_gateway_data' Grant Erickson
2023-12-06 23:49 ` Grant Erickson [this message]
2023-12-06 23:49 ` [PATCH 03/90] connection: Replace gateway config active Boolean Grant Erickson
2023-12-06 23:49 ` [PATCH 04/90] connection: Document gateway configuration state Grant Erickson
2023-12-06 23:49 ` [PATCH 05/90] connection: Replace gateway config VPN Boolean Grant Erickson
2023-12-06 23:49 ` [PATCH 06/90] connection: Document gateway configuration flags Grant Erickson
2023-12-06 23:49 ` [PATCH 07/90] connection: Introduce gateway configuration 'type' Grant Erickson
2023-12-06 23:49 ` [PATCH 08/90] connection: Document 'gateway_config_type' Grant Erickson
2023-12-06 23:49 ` [PATCH 09/90] connection: Add function parameter to {un,}set_default_gateway Grant Erickson
2023-12-06 23:49 ` [PATCH 10/90] connection: Fix 'DBG' copy-and-paste typo Grant Erickson
2023-12-06 23:49 ` [PATCH 11/90] connection: Split '{un,}_default_gateway' IP-specific functions Grant Erickson
2023-12-06 23:49 ` [PATCH 12/90] connection: Add 'DBG' to 'del_gateway_routes' Grant Erickson
2023-12-06 23:49 ` [PATCH 13/90] connection: Rename 'active_gateway' local Grant Erickson
2023-12-06 23:49 ` [PATCH 14/90] connection: Check 'service' parameter for null Grant Erickson
2023-12-06 23:49 ` [PATCH 15/90] connection: Check service network index for validity Grant Erickson
2023-12-06 23:49 ` [PATCH 16/90] connection: Refactor '__connman_connection_gateway_add' Grant Erickson
2023-12-06 23:49 ` [PATCH 17/90] connection: Remove 'DBG' from '__connman_connection_update_gateway' Grant Erickson
2023-12-06 23:49 ` [PATCH 18/90] connection: Refactor 'yield_default_gateway' Grant Erickson
2023-12-06 23:49 ` [PATCH 19/90] connection: Document 'gateway_data_config_get' Grant Erickson
2023-12-06 23:49 ` [PATCH 20/90] connection: Document 'yield_default_gateway_for_type' Grant Erickson
2023-12-06 23:49 ` [PATCH 21/90] connection: Add 'gateway_config_free' Grant Erickson
2023-12-06 23:49 ` [PATCH 22/90] connection: Document 'gateway_config_free' Grant Erickson
2023-12-06 23:49 ` [PATCH 23/90] connection: Introduce and leverage 'mutate_default_gateway' Grant Erickson
2023-12-06 23:49 ` [PATCH 24/90] connection: Document 'mutate_default_gateway_ops' Grant Erickson
2023-12-06 23:49 ` [PATCH 25/90] connection: Document 'mutate_default_gateway' Grant Erickson
2023-12-06 23:49 ` [PATCH 26/90] connection: Add gateway config ADDED/REMOVED states Grant Erickson
2023-12-06 23:49 ` [PATCH 27/90] connection: Add low-priority default gateway config type Grant Erickson
2023-12-06 23:49 ` [PATCH 28/90] connection: Change return type of 'unset_default_gateway' Grant Erickson
2023-12-06 23:49 ` [PATCH 29/90] connection: Leverage 'unset_default_gateway' in 'del_gateway_routes' Grant Erickson
2023-12-06 23:49 ` [PATCH 30/90] connection: Change return type of 'set_default_gateway' Grant Erickson
2023-12-06 23:49 ` [PATCH 31/90] connection: Fan out route manipulation into callbacks Grant Erickson
2023-12-06 23:49 ` [PATCH 32/90] connection: Document 'mutate_default_gateway_route_cb_t' Grant Erickson
2023-12-06 23:49 ` [PATCH 33/90] connection: Document 'set_default_gateway_route_common' Grant Erickson
2023-12-06 23:49 ` [PATCH 34/90] connection: Document 'unset_default_gateway_route_common' Grant Erickson
2023-12-06 23:49 ` [PATCH 35/90] inet: Add '__connman_inet_table2string' Grant Erickson
2023-12-06 23:49 ` [PATCH 36/90] inet: Document '__connman_inet_table2string' Grant Erickson
2023-12-06 23:50 ` [PATCH 37/90] inet: Leverage '__connman_inet_table2string' Grant Erickson
2023-12-06 23:50 ` [PATCH 38/90] rtnl: Add support for extracting the table identifier Grant Erickson
2023-12-06 23:50 ` [PATCH 39/90] ipconfig: Pass the rtnl table to '__connman_ipconfig_{new,del}route' Grant Erickson
2023-12-06 23:50 ` [PATCH 39/90] ipconfig: Pass the rtnl table to " Grant Erickson
2023-12-06 23:50 ` [PATCH 40/90] rtnl: Add support for extracting the metric/priority Grant Erickson
2023-12-06 23:50 ` [PATCH 41/90] ipconfig: Pass the rtnl metric to '__connman_ipconfig_{new,del}route' Grant Erickson
2023-12-06 23:50 ` [PATCH 41/90] ipconfig: Pass the rtnl metric to " Grant Erickson
2023-12-06 23:50 ` [PATCH 42/90] ipconfig: Pass the rtnl dst prefixlen " Grant Erickson
2023-12-06 23:50 ` [PATCH 42/90] ipconfig: Pass the rtnl dst prefixlen to " Grant Erickson
2023-12-06 23:50 ` [PATCH 43/90] inet: Include interface index and name in 'DBG' Grant Erickson
2023-12-06 23:50 ` [PATCH 44/90] inet: Include the command value and string " Grant Erickson
2023-12-06 23:50 ` [PATCH 45/90] ipconfig: Use 'RT_SCOPE_*' mnemonics Grant Erickson
2023-12-06 23:50 ` [PATCH 46/90] inet: Add a metric parameter to 'iproute_default_modify' Grant Erickson
2023-12-06 23:50 ` [PATCH 47/90] inet: Document 'iproute_default_modify' Grant Erickson
2023-12-06 23:50 ` [PATCH 48/90] connection: Document '__connman_inet_add_default_to_table' Grant Erickson
2023-12-06 23:50 ` [PATCH 49/90] connection: Document '__connman_inet_del_default_to_table' Grant Erickson
2023-12-06 23:50 ` [PATCH 50/90] inet: Add '__connman_inet_{add,del}_default_{to,from}_table_with_metric' Grant Erickson
2023-12-06 23:50 ` [PATCH 51/90] inet: Document '__connman_inet_{add,del}_default_{to,from}_table_with_metric' Grant Erickson
2023-12-06 23:50 ` [PATCH 52/90] connection: Add support for low-priority default routes Grant Erickson
2023-12-06 23:50 ` [PATCH 53/90] connection: Introduce '{de,pro}mote_default_gateway' Grant Erickson
2023-12-06 23:50 ` [PATCH 54/90] connection: Add 'is_addr_any_str' Grant Erickson
2023-12-06 23:50 ` [PATCH 55/90] connection: Introduce gateway config 'ops' Grant Erickson
2023-12-06 23:50 ` [PATCH 56/90] connection: Refactor 'add_host_route' Grant Erickson
2023-12-06 23:50 ` [PATCH 57/90] connection: Add 'DBG' else clauses to 'connection_delgateway' Grant Erickson
2023-12-06 23:50 ` [PATCH 58/90] connection: Document 'gateway_config_state' finite state machine Grant Erickson
2023-12-06 23:50 ` [PATCH 59/90] connection: Document 'gateway_config_ops' Grant Erickson
2023-12-06 23:50 ` [PATCH 60/90] connection: Document 'gateway_config' Grant Erickson
2023-12-06 23:50 ` [PATCH 61/90] connection: Document 'gateway_data' Grant Erickson
2023-12-06 23:50 ` [PATCH 62/90] connection: Document 'gateway_hash' Grant Erickson
2023-12-06 23:50 ` [PATCH 63/90] connection: Document 'is_addr_any_str' Grant Erickson
2023-12-06 23:50 ` [PATCH 64/90] connection: Update 'find_any_active_gateway_data' documentation Grant Erickson
2023-12-06 23:50 ` [PATCH 65/90] connection: Document 'compute_low_priority_metric' Grant Erickson
2023-12-06 23:50 ` [PATCH 66/90] connection: Document 'add_host_route' Grant Erickson
2023-12-06 23:50 ` [PATCH 67/90] connection: Document call to 'connman_service_unref' Grant Erickson
2023-12-06 23:50 ` [PATCH 68/90] connection: Document 'demote_default_gateway' Grant Erickson
2023-12-06 23:50 ` [PATCH 69/90] connection: Document 'promote_default_gateway' Grant Erickson
2023-12-06 23:50 ` [PATCH 70/90] connection: Document 'set_ipv4_high_priority_default_gateway_route_cb' Grant Erickson
2023-12-06 23:50 ` [PATCH 71/90] connection: Document 'set_ipv6_high_priority_default_gateway_route_cb' Grant Erickson
2023-12-06 23:50 ` [PATCH 72/90] connection: Document 'set_ipv4_high_priority_default_gateway' Grant Erickson
2023-12-06 23:50 ` [PATCH 73/90] connection: Document 'set_ipv6_high_priority_default_gateway' Grant Erickson
2023-12-06 23:50 ` [PATCH 74/90] connection: Document 'unset_ipv4_high_priority_default_gateway_route_cb' Grant Erickson
2023-12-06 23:50 ` [PATCH 75/90] connection: Document 'unset_ipv6_high_priority_default_gateway_route_cb' Grant Erickson
2023-12-06 23:50 ` [PATCH 76/90] connection: Document 'unset_ipv4_high_priority_default_gateway' Grant Erickson
2023-12-06 23:50 ` [PATCH 77/90] connection: Document 'unset_ipv6_high_priority_default_gateway' Grant Erickson
2023-12-06 23:50 ` [PATCH 78/90] connection: Document 'set_ipv4_low_priority_default_gateway_route_cb' Grant Erickson
2023-12-06 23:50 ` [PATCH 79/90] connection: Document 'set_ipv4_low_priority_default_gateway' Grant Erickson
2023-12-06 23:50 ` [PATCH 80/90] connection: Document 'set_low_priority_default_gateway' Grant Erickson
2023-12-06 23:50 ` [PATCH 81/90] connection: Document 'unset_ipv4_low_priority_default_gateway_route_cb' Grant Erickson
2023-12-06 23:50 ` [PATCH 82/90] connection: Document 'unset_ipv4_low_priority_default_gateway' Grant Erickson
2023-12-06 23:50 ` [PATCH 83/90] connection: Document 'unset_low_priority_default_gateway' Grant Erickson
2023-12-06 23:50 ` [PATCH 84/90] connection: Fix documentation typos Grant Erickson
2023-12-06 23:50 ` [PATCH 85/90] connection: Update 'set_default_gateway_route_common' documentation Grant Erickson
2023-12-06 23:50 ` [PATCH 86/90] connection: Update 'unset_default_gateway_route_common' documentation Grant Erickson
2023-12-06 23:50 ` [PATCH 87/90] connection: Update '{un,}set_default_gateway' documentation Grant Erickson
2023-12-06 23:50 ` [PATCH 88/90] connection: Add @file comment Grant Erickson
2023-12-06 23:50 ` [PATCH 89/90] connection: Add whitespace around 'del_gateway_routes_if_active' Grant Erickson
2023-12-06 23:50 ` [PATCH 90/90] connection: Ensure function attribution 'DBG' output is consistent Grant Erickson

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=20231206235056.322578-3-gerickson@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).