diff options
author | Grant Erickson <gerickson@nuovations.com> | 2023-12-06 11:31:55 -0800 |
---|---|---|
committer | Marcel Holtmann <marcel@holtmann.org> | 2023-12-08 01:55:44 +0100 |
commit | fbd7123841f645d8af13f8ba27b2cfb9e40ee8c8 (patch) | |
tree | e677b4e540f60d4a4ce6315cdaf359557770a6f9 | |
parent | 1df9e762f90d6a2c7fea487a915e78ca5f98c2f3 (diff) | |
download | connman-fbd7123841f645d8af13f8ba27b2cfb9e40ee8c8.tar.gz |
connection: Document 'unset_ipv6_high_priority_default_gateway_route_cb'.
This adds documentation to the
'unset_ipv6_high_priority_default_gateway_route_cb' function.
-rw-r--r-- | src/connection.c | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/src/connection.c b/src/connection.c index e890877f2..4aaffbf7e 100644 --- a/src/connection.c +++ b/src/connection.c @@ -2072,6 +2072,42 @@ done: return err; } +/** + * @brief + * Unset, or remove, the IPv6 high-priority default route for the + * specified gateway data and configuration using a function + * utilizing a SIOCDELRT socket ioctl or a RTM_DELROUTE Linux + * Routing Netlink (rtnl) command. + * + * This attempts to unset, or remove, the IPv6 high-priority (that + * is, metric 0) default route for the specified gateway data and + * configuration using a function utilizing a SIOCDELRT socket ioctl + * or a RTM_DELROUTE Linux Routing Netlink (rtnl) command to modify + * the Linux routing table. + * + * @param[in,out] data A pointer to the mutable gateway data to + * use to unset, or remove, the IPv6 + * high-priority default route. + * @param[in,out] config A pointer to the mutable gateway + * configuration to use to unset, or remove, + * the IPv6 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 set, or added, was invalid. + * @retval -EPERM If the current process does not have the + * credentials or capabilities to set, or + * add, routes. + * @retval -ESRCH A request was made to delete a non-existing + * routing entry. + * + * @sa connman_inet_clear_ipv6_gateway_interface + * @sa connman_inet_clear_ipv6_gateway_address + * + */ static int unset_ipv6_high_priority_default_gateway_route_cb( struct gateway_data *data, struct gateway_config *config) |