diff options
| author | Grant Erickson <gerickson@nuovations.com> | 2023-12-16 00:28:03 -0800 |
|---|---|---|
| committer | Marcel Holtmann <marcel@holtmann.org> | 2023-12-16 19:46:48 +0100 |
| commit | 3c592090946d456a4c0e9828c9c498caf6876ca2 (patch) | |
| tree | db262a85f51688a27219b60e8315d6cc5e290b88 | |
| parent | aebf73fee5991bcca8931b3b88bc8c2281ce2248 (diff) | |
| download | connman-3c592090946d456a4c0e9828c9c498caf6876ca2.tar.gz | |
inet: Document 'nameserver_{add,del}_routes'.
This adds documentation to the 'nameserver_{add,del}_routes'
functions.
| -rw-r--r-- | src/service.c | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/src/service.c b/src/service.c index 8821445f3..7e14a3dbf 100644 --- a/src/service.c +++ b/src/service.c @@ -1457,6 +1457,31 @@ static void del_nameserver_route(int family, int index, const char *nameserver, } } +/** + * @brief + * Add IPv4 or IPv6 host routes for the specified domain name + * service (DNS) servers. + * + * This attempts to add IPv4 or IPv6 host routes for the specified + * domain name service (DNS) servers with the specified attributes. + * + * @param[in] index The network interface index associated + * with the output network device for + * the route. + * @param[in] nameservers A pointer to a null-terminated array of + * mutable null-terminated C strings + * containing the IPv4 or IPv6 addresses, in + * text form, of the route DNS server + * destination addresses. + * @param[in] gw A pointer to an immutable null-terminated + * C string containing the IPv4 or IPv6 + * address, in text form, of the route next + * hop gateway address. + * + * @sa add_nameserver_route + * @sa nameserver_del_routes + * + */ static void nameserver_add_routes(int index, char **nameservers, const char *gw) { @@ -1475,6 +1500,31 @@ static void nameserver_add_routes(int index, char **nameservers, } } +/** + * @brief + * Delete IPv4 or IPv6 host routes for the specified domain name + * service (DNS) servers. + * + * This attempts to delete IPv4 or IPv6 host routes for the specified + * domain name service (DNS) servers with the specified attributes. + * + * @param[in] index The network interface index associated + * with the output network device for + * the route. + * @param[in] nameservers A pointer to a null-terminated array of + * mutable null-terminated C strings + * containing the IPv4 or IPv6 addresses, in + * text form, of the route DNS server + * destination addresses. + * @param[in] gw A pointer to an immutable null-terminated + * C string containing the IPv4 or IPv6 + * address, in text form, of the route next + * hop gateway address. + * + * @sa del_nameserver_route + * @sa nameserver_add_routes + * + */ static void nameserver_del_routes(int index, char **nameservers, const char *gw, enum connman_ipconfig_type type) |