diff options
| author | Grant Erickson <gerickson@nuovations.com> | 2023-12-16 00:28:02 -0800 |
|---|---|---|
| committer | Marcel Holtmann <marcel@holtmann.org> | 2023-12-16 19:46:48 +0100 |
| commit | aebf73fee5991bcca8931b3b88bc8c2281ce2248 (patch) | |
| tree | 066b26e730f02b50081e952400e035a58396b922 | |
| parent | 319ca5c3d3d42dc819c534b512f13048a019c623 (diff) | |
| download | connman-aebf73fee5991bcca8931b3b88bc8c2281ce2248.tar.gz | |
inet: Document '{add,del}_nameserver_route'.
This adds documentation to the '{add,del}_nameserver_route' functions.
| -rw-r--r-- | src/service.c | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/src/service.c b/src/service.c index e0a11a2bc..8821445f3 100644 --- a/src/service.c +++ b/src/service.c @@ -1345,6 +1345,32 @@ void __connman_service_nameserver_clear(struct connman_service *service) nameserver_add_all(service, CONNMAN_IPCONFIG_TYPE_ALL); } +/** + * @brief + * Add an IPv4 or IPv6 host route for the specified domain name + * service (DNS) server. + * + * This attempts to add an IPv4 or IPv6 host route for the specified + * domain name service (DNS) server with the specified attributes. + * + * @param[in] family The address family describing the + * address pointed to by @a nameserver. + * @param[in] index The network interface index associated + * with the output network device for + * the route. + * @param[in] nameserver A pointer to an immutable null-terminated + * C string containing the IPv4 or IPv6 + * address, in text form, of the route + * DNS server destination address. + * @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 add_nameserver_route(int family, int index, const char *nameserver, const char *gw) { @@ -1370,6 +1396,33 @@ static void add_nameserver_route(int family, int index, const char *nameserver, } } +/** + * @brief + * Delete an IPv4 or IPv6 host route for the specified domain name + * service (DNS) server. + * + * This attempts to delete an IPv4 or IPv6 host route for the + * specified domain name service (DNS) server with the specified + * attributes. + * + * @param[in] family The address family describing the + * address pointed to by @a nameserver. + * @param[in] index The network interface index associated + * with the output network device for + * the route. + * @param[in] nameserver A pointer to an immutable null-terminated + * C string containing the IPv4 or IPv6 + * address, in text form, of the route + * DNS server destination address. + * @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 del_nameserver_route(int family, int index, const char *nameserver, const char *gw, enum connman_ipconfig_type type) |