diff options
author | Grant Erickson <gerickson@nuovations.com> | 2023-12-06 01:30:40 -0800 |
---|---|---|
committer | Marcel Holtmann <marcel@holtmann.org> | 2023-12-08 01:55:44 +0100 |
commit | d9e66dae7bce8b3b7fa96209b0e1b609c1f572c7 (patch) | |
tree | 6dc7f5413b41132c5fadfdf6932fac27ed113500 | |
parent | d4261822ddfb0a2b0acfc18b845c2f1d5accd315 (diff) | |
download | connman-d9e66dae7bce8b3b7fa96209b0e1b609c1f572c7.tar.gz |
connection: Document '__connman_inet_del_default_to_table'.
This adds documentation to the '__connman_inet_del_default_to_table'
function.
-rw-r--r-- | src/inet.c | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/src/inet.c b/src/inet.c index 32bae2a35..5c5100e25 100644 --- a/src/inet.c +++ b/src/inet.c @@ -3392,6 +3392,38 @@ int __connman_inet_add_subnet_to_table(uint32_t table_id, int ifindex, gateway, prefixlen); } +/** + * @brief + * Delete a gateway default route. + * + * This attempts to delete a gateway default route from the kernel + * routing table, @a table_id, using a Linux Route Netlink (rtnl) + * socket and protocol with the specified attributes, including an + * implicit metric/prioity of zero (0), the highest priority. + * + * @param[in] table_id The table to delete this route from. + * @param[in] ifindex The network interface index associated with + * the output network device for the route. + * @param[in] gateway A pointer to an immutable null-terminated C + * string containing the IPv4 or IPv6 address, + * in text form, of the route destination or + * next hop gateway address. + * + * @retval 0 If successful. + * @retval -EINVAL If the address family of @a gateway was not AF_INET + * (IPv4) or AF_INET6 (IPv6), if @a gateway does not + * contain a character string representing a valid + * network address in either the AF_INET or + * AF_INET6 family, or if the routing information + * to be deleted was invalid. + * @retval -EFAULT If the address to the routing information to be + * deleted was invalid. + * @retval -EPERM If the current process does not have the + * credentials or capabilities to delete routes. + * @retval -ESRCH A request was made to delete a non-existing + * routing entry. + * + */ int __connman_inet_del_default_from_table(uint32_t table_id, int ifindex, const char *gateway) { |