1mDNS 服务
2=========
3:link_to_translation:`en:[English]`
4
5概述
6----
7
8mDNS 是一种组播 UDP 服务，用来提供本地网络服务和主机发现。
9
10绝大多数的操作系统默认都会安装 mDNS 服务，或者提供单独的安装包。``Mac OS`` 默认会安装名为 ``Bonjour`` 的服务（该服务基于 mDNS），此外 Apple 还发布了适用于 Windows 系统的安装程序，可以在 `官方支持 <https://support.apple.com/downloads/bonjour%2520for%2520windows>`_ 找到。在 ``Linux`` 上，mDNS 服务由 `avahi <https://github.com/lathiat/avahi>`_ 提供，通常也会被默认安装。
11
12mDNS 属性
13^^^^^^^^^
14
15    * ``hostname``：设备会去响应的主机名，如果没有设置，会根据设备的网络接口名定义 ``hostname`` 。例如，``my-{IDF_TARGET_PATH_NAME}`` 会被解析为 ``my-{IDF_TARGET_PATH_NAME}.local``。
16    * ``default_instance``：默认实例名（即易记的设备名），例如 ``Jhon's {IDF_TARGET_NAME} Thing``。如果没有设置，将会使用 ``hostname``。
17
18以下为 STA 接口启动 mDNS 服务并设置 ``hostname`` 和 ``default_instance`` 的示例方法：
19
20.. highlight:: c
21
22::
23
24    void start_mdns_service()
25    {
26        // 初始化 mDNS 服务
27        esp_err_t err = mdns_init();
28        if (err) {
29            printf("MDNS Init failed: %d\n", err);
30            return;
31        }
32
33        // 设置 hostname
34        mdns_hostname_set("my-{IDF_TARGET_PATH_NAME}");
35        // 设置默认实例
36        mdns_instance_name_set("Jhon's {IDF_TARGET_NAME} Thing");
37    }
38
39mDNS 服务
40^^^^^^^^^
41
42mDNS 可以广播设备能够提供的网络服务的相关信息，每个服务会由以下属性构成。
43
44    * ``instance_name``：实例名（即易记的服务名），例如 ``Jhon's {IDF_TARGET_NAME} Web Server``。如果没有定义，会使用 ``default_instance``。
45    * ``service_type``：（必需）服务类型，以下划线为前缀，`这里 <http://www.dns-sd.org/serviceTypes.html>`_ 列出了常见的类型。
46    * ``proto``：（必需）服务运行所依赖的协议，以下划线为前缀，例如 ``_tcp`` 或者 ``_udp``。
47    * ``port``：（必需）服务运行所用的端口号。
48    * ``txt``：形如 ``{var, val}`` 的字符串数组，用于定义服务的属性。
49
50添加一些服务和不同属性的示例方法::
51
52    void add_mdns_services()
53    {
54        // 添加服务
55        mdns_service_add(NULL, "_http", "_tcp", 80, NULL, 0);
56        mdns_service_add(NULL, "_arduino", "_tcp", 3232, NULL, 0);
57        mdns_service_add(NULL, "_myservice", "_udp", 1234, NULL, 0);
58
59        // 注意：必须先添加服务，然后才能设置其属性
60        // web 服务器使用自定义的实例名
61        mdns_service_instance_name_set("_http", "_tcp", "Jhon's {IDF_TARGET_NAME} Web Server");
62
63        mdns_txt_item_t serviceTxtData[3] = {
64            {"board","{IDF_TARGET_PATH_NAME}"},
65            {"u","user"},
66            {"p","password"}
67        };
68        // 设置服务的文本数据（会释放并替换当前数据）
69        mdns_service_txt_set("_http", "_tcp", serviceTxtData, 3);
70
71        // 修改服务端口号
72        mdns_service_port_set("_myservice", "_udp", 4321);
73    }
74
75mDNS 查询
76^^^^^^^^^
77
78mDNS 提供查询服务和解析主机 IP/IPv6 地址的方法。
79
80服务查询的结果会作为 ``mdns_result_t`` 类型对象的链表返回。
81
82解析主机 IP 地址的示例方法::
83
84    void resolve_mdns_host(const char * host_name)
85    {
86        printf("Query A: %s.local", host_name);
87
88        struct ip4_addr addr;
89        addr.addr = 0;
90
91        esp_err_t err = mdns_query_a(host_name, 2000,  &addr);
92        if(err){
93            if(err == ESP_ERR_NOT_FOUND){
94                printf("Host was not found!");
95                return;
96            }
97            printf("Query Failed");
98            return;
99        }
100
101        printf(IPSTR, IP2STR(&addr));
102    }
103
104解析本地服务的示例方法::
105
106    static const char * if_str[] = {"STA", "AP", "ETH", "MAX"};
107    static const char * ip_protocol_str[] = {"V4", "V6", "MAX"};
108
109    void mdns_print_results(mdns_result_t * results){
110        mdns_result_t * r = results;
111        mdns_ip_addr_t * a = NULL;
112        int i = 1, t;
113        while(r){
114            printf("%d: Interface: %s, Type: %s\n", i++, if_str[r->tcpip_if], ip_protocol_str[r->ip_protocol]);
115            if(r->instance_name){
116                printf("  PTR : %s\n", r->instance_name);
117            }
118            if(r->hostname){
119                printf("  SRV : %s.local:%u\n", r->hostname, r->port);
120            }
121            if(r->txt_count){
122                printf("  TXT : [%u] ", r->txt_count);
123                for(t=0; t<r->txt_count; t++){
124                    printf("%s=%s; ", r->txt[t].key, r->txt[t].value);
125                }
126                printf("\n");
127            }
128            a = r->addr;
129            while(a){
130                if(a->addr.type == IPADDR_TYPE_V6){
131                    printf("  AAAA: " IPV6STR "\n", IPV62STR(a->addr.u_addr.ip6));
132                } else {
133                    printf("  A   : " IPSTR "\n", IP2STR(&(a->addr.u_addr.ip4)));
134                }
135                a = a->next;
136            }
137            r = r->next;
138        }
139
140    }
141
142    void find_mdns_service(const char * service_name, const char * proto)
143    {
144        ESP_LOGI(TAG, "Query PTR: %s.%s.local", service_name, proto);
145
146        mdns_result_t * results = NULL;
147        esp_err_t err = mdns_query_ptr(service_name, proto, 3000, 20,  &results);
148        if(err){
149            ESP_LOGE(TAG, "Query Failed");
150            return;
151        }
152        if(!results){
153            ESP_LOGW(TAG, "No results found!");
154            return;
155        }
156
157        mdns_print_results(results);
158        mdns_query_results_free(results);
159    }
160
161使用上述方法的示例::
162
163    void my_app_some_method(){
164        // 搜索 {IDF_TARGET_PATH_NAME}-mdns.local
165        resolve_mdns_host("{IDF_TARGET_PATH_NAME}-mdns");
166
167        // 搜索 HTTP 服务器
168        find_mdns_service("_http", "_tcp");
169        // 或者搜索文件服务器
170        find_mdns_service("_smb", "_tcp"); // Windows 系统的共享服务
171        find_mdns_service("_afpovertcp", "_tcp"); // Apple AFP 文件共享服务
172        find_mdns_service("_nfs", "_tcp"); // NFS 服务器
173        find_mdns_service("_ftp", "_tcp"); // FTP 服务器
174        // 或者网络打印机
175        find_mdns_service("_printer", "_tcp");
176        find_mdns_service("_ipp", "_tcp");
177    }
178
179应用示例
180--------
181
182有关 mDNS 服务器和查询器的应用示例请参考 :example:`protocols/mdns`。
183
184API 参考
185--------
186
187.. include-build-file:: inc/mdns.inc
188
189
190