mirror/lwip
1
0
Fork 0
mirror of https://github.com/lwip-tcpip/lwip.git synced 2024-07-07 13:29:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc/mdns.txt: Update document for mdns API changes

Browse Source 
Update mdns.txt for below API changes:
* mdns_resp_add_netif() no longer has dns_ttl argument
* mdns_resp_add_service() no longer has dns_ttl arguemnt
* mdns_resp_add_service() uses enum mdns_sd_proto for proto argument
* Add missing const qualifier at appropriate places

Signed-off-by: Axel Lin <axel.lin@ingics.com>
This commit is contained in:
Axel Lin 2018-11-19 23:24:05 +08:00
parent aa83bdf490
commit 4413576494
1 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/mdns.txt
View File

@ -45,7 +45,7 @@ This opens UDP sockets on port 5353 for IPv4 and IPv6.
To start responding on a netif, run To start responding on a netif, run
mdns_resp_add_netif(struct netif *netif, char *hostname, u32_t dns_ttl) mdns_resp_add_netif(struct netif *netif, const char *hostname)
The hostname will be copied. If this returns successfully, the netif will join The hostname will be copied. If this returns successfully, the netif will join
the multicast groups and any MDNS/legacy DNS requests sent unicast or multicast the multicast groups and any MDNS/legacy DNS requests sent unicast or multicast
@ -53,7 +53,6 @@ to port 5353 will be handled:
- <hostname>.local type A, AAAA or ANY returns relevant IP addresses - <hostname>.local type A, AAAA or ANY returns relevant IP addresses
- Reverse lookups (PTR in-addr.arpa, ip6.arpa) of netif addresses - Reverse lookups (PTR in-addr.arpa, ip6.arpa) of netif addresses
returns <hostname>.local returns <hostname>.local
Answers will use the supplied TTL (in seconds)
MDNS allows UTF-8 names, but it is recommended to stay within ASCII, MDNS allows UTF-8 names, but it is recommended to stay within ASCII,
since the default case-insensitive comparison assumes this. since the default case-insensitive comparison assumes this.
@ -71,8 +70,8 @@ Adding services:
================ ================
The netif first needs to be registered. Then run The netif first needs to be registered. Then run
mdns_resp_add_service(struct netif *netif, char *name, char *service, mdns_resp_add_service(struct netif *netif, const char *name, const char *service,
u16_t proto, u16_t port, u32_t dns_ttl, enum mdns_sd_proto proto, u16_t port,
service_get_txt_fn_t txt_fn, void *txt_userdata); service_get_txt_fn_t txt_fn, void *txt_userdata);
The name and service pointers will be copied. Name refers to the name of the The name and service pointers will be copied. Name refers to the name of the
@ -100,7 +99,7 @@ If this call returns successfully, the following queries will be answered:
If your device runs a webserver on port 80, an example call might be: If your device runs a webserver on port 80, an example call might be:
mdns_resp_add_service(netif, "myweb", "_http" mdns_resp_add_service(netif, "myweb", "_http"
DNSSD_PROTO_TCP, 80, 3600, srv_txt, NULL); DNSSD_PROTO_TCP, 80, srv_txt, NULL);
which will publish myweb._http._tcp.local for any hosts looking for web servers, which will publish myweb._http._tcp.local for any hosts looking for web servers,
and point them to <hostname>.local:80 and point them to <hostname>.local:80
@ -109,4 +108,4 @@ Relevant information will be sent as additional records to reduce number of
requests required from a client. requests required from a client.
To remove a service from a netif, run To remove a service from a netif, run
mdns_resp_del_service(struct netif *netif, s8_t slot) mdns_resp_del_service(struct netif *netif, s8_t slot)