mDNS: Updated APIs description and shows the warning when hostname contains domain name during the query

Closes https://github.com/espressif/esp-idf/issues/6590


* Original commit: espressif/esp-idf@9f8d2b944d
This commit is contained in:
suren.gabrielyan
2021-02-26 18:28:57 +04:00
committed by suren-gabrielyan-espressif
parent eda5d72acf
commit 22c7c0a195
2 changed files with 12 additions and 0 deletions

View File

@ -343,6 +343,8 @@ esp_err_t mdns_query_a(const char * host_name, uint32_t timeout, esp_ip4_addr_t
/**
* @brief Query mDNS for A record
*
* Please note that hostname must not contain domain name, as mDNS uses '.local' domain.
*
* @param host_name host name to look for
* @param timeout time in milliseconds to wait for answer. If 0, max_results needs to be defined
* @param addr pointer to the resulting IP6 address
@ -361,6 +363,8 @@ esp_err_t mdns_query_aaaa(const char * host_name, uint32_t timeout, esp_ip6_addr
* This method controls the service state on all active interfaces and applications are required
* to call it from the system event handler for normal operation of mDNS service.
*
* Please note that hostname must not contain domain name, as mDNS uses '.local' domain.
*
* @param ctx The system event context
* @param event The system event
*/