diff options
author | Grant Erickson <gerickson@nuovations.com> | 2023-12-06 11:32:33 -0800 |
---|---|---|
committer | Marcel Holtmann <marcel@holtmann.org> | 2023-12-08 01:55:44 +0100 |
commit | c22e0164533a4a186480766ce444dee4992d9f7f (patch) | |
tree | 61f761d509f8b2cef0cb7722f05e44e44c4aa50e | |
parent | fbd7123841f645d8af13f8ba27b2cfb9e40ee8c8 (diff) | |
download | connman-c22e0164533a4a186480766ce444dee4992d9f7f.tar.gz |
connection: Document 'unset_ipv4_high_priority_default_gateway'.
This adds documentation to the
'unset_ipv4_high_priority_default_gateway' function.
-rw-r--r-- | src/connection.c | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/src/connection.c b/src/connection.c index 4aaffbf7e..df5c4d158 100644 --- a/src/connection.c +++ b/src/connection.c @@ -2146,6 +2146,38 @@ done: return err; } +/** + * @brief + * Unset, or clear, the IPv4 high-priority default route for the + * specified gateway data and configuration. + * + * This attempts to unset, or clear, the IPv4 high-priority (that is, + * metric 0) default route from the provided gateway data and + * configuration. + * + * @param[in,out] data A pointer to the mutable gateway data to + * use to unset, or remove, the IPv4 + * high-priority default route. + * @param[in,out] config A pointer to the mutable gateway + * configuration to use to unset, or remove, + * the IPv4 high-priority default route. + * + * @retval 0 If successful. + * @retval -EINVAL If @a data or @a config are null; or if + * the routing information to be unset, or + * removed, was invalid. + * @retval -EFAULT If the address to the routing information + * to be unset, or cleared, was invalid. + * @retval -EPERM If the current process does not have the + * credentials or capabilities to unset, or + * clear, routes. + * @retval -ESRCH A request was made to unset, or clear a + * non-existing routing entry. + * + * @sa unset_default_gateway_route_common + * @sa unset_ipv4_high_priority_default_gateway_route_cb + * + */ static int unset_ipv4_high_priority_default_gateway( struct gateway_data *data, struct gateway_config *config) |