Chapter 2. API Reference
(continued from previous page)
//or file servers
find_mdns_service("_smb", "_tcp"); //windows sharing
find_mdns_service("_afpovertcp", "_tcp"); //apple sharing
find_mdns_service("_nfs", "_tcp"); //NFS server
find_mdns_service("_ftp", "_tcp"); //FTP server
//or networked printer
find_mdns_service("_printer", "_tcp");
find_mdns_service("_ipp", "_tcp");
}
Application Example
mDNS server/scanner example: protocols/mdns.
API Reference
Header File
• components/mdns/include/mdns.h
Functions
esp_err_t mdns_init(void)
Initialize mDNS on given interface.
Return
• ESP_OK on success
• ESP_ERR_INVALID_STATE when failed to register event handler
• ESP_ERR_NO_MEM on memory error
• ESP_FAIL when failed to start mdns task
void mdns_free(void)
Stop and free mDNS server.
esp_err_t mdns_hostname_set(const char *hostname)
Set the hostname for mDNS server required if you want to advertise services.
Return
• ESP_OK success
• ESP_ERR_INVALID_ARG Parameter error
• ESP_ERR_NO_MEM memory error
Parameters
• hostname: Hostname to set
esp_err_t mdns_delegate_hostname_add(const char *hostname, const mdns_ip_addr_t
*address_list)
Adds a hostname and address to be delegated A/AAAA queries will be replied for the hostname and services
can be added to this host.
Return
• ESP_OK success
• ESP_ERR_INVALID_STATE mDNS is not running
• ESP_ERR_INVALID_ARG Parameter error
• ESP_ERR_NO_MEM memory error
Parameters
• hostname: Hostname to add
• address_list: The IP address list of the host
esp_err_t mdns_delegate_hostname_remove(const char *hostname)
Remove a delegated hostname All the services added to this host will also be removed.
Espressif Systems 611
Submit Document Feedback
Release v4.4
To Next Page