diff options
author | Grant Erickson <gerickson@nuovations.com> | 2023-12-06 00:17:58 -0800 |
---|---|---|
committer | Marcel Holtmann <marcel@holtmann.org> | 2023-12-08 01:55:44 +0100 |
commit | 84f3edec276611772ee0c4597109cab05fffabd4 (patch) | |
tree | 0e5850342e1a578c8b4bd254edb828df3d9615cf | |
parent | 2bc98078d3139d4a800e072639b2242ce6bcca4d (diff) | |
download | connman-84f3edec276611772ee0c4597109cab05fffabd4.tar.gz |
connection: Document 'mutate_default_gateway_route_cb_t'.
This adds documentation to the 'mutate_default_gateway_route_cb_t'
typedef.
-rw-r--r-- | src/connection.c | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/src/connection.c b/src/connection.c index 1bcf16dee..53563d057 100644 --- a/src/connection.c +++ b/src/connection.c @@ -203,6 +203,23 @@ struct mutate_default_gateway_ops { struct gateway_config *config); }; +/** + * Prototype for a function callback to mutate (that is, add/set or + * clear/delete/remove) a default route for a gateway using a function + * utilizing a SIOCADDRT / SIOCDELRT socket ioctl or a RTM_NEWROUTE / + * 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 mutate the default route. + * @param[in,out] config A pointer to the mutable gateway + * configuration to use to mutate the + * default route. + * + * @returns + * 0 if successful; otherwise, < 0 on error. + * + */ typedef int (*mutate_default_gateway_route_cb_t)(struct gateway_data *data, struct gateway_config *config); |