xref: /nrf52832-nimble/rt-thread/components/net/lwip-2.1.0/src/include/lwip/apps/mdns.h (revision 104654410c56c573564690304ae786df310c91fc)
1*10465441SEvalZero /**
2*10465441SEvalZero  * @file
3*10465441SEvalZero  * MDNS responder
4*10465441SEvalZero  */
5*10465441SEvalZero 
6*10465441SEvalZero  /*
7*10465441SEvalZero  * Copyright (c) 2015 Verisure Innovation AB
8*10465441SEvalZero  * All rights reserved.
9*10465441SEvalZero  *
10*10465441SEvalZero  * Redistribution and use in source and binary forms, with or without modification,
11*10465441SEvalZero  * are permitted provided that the following conditions are met:
12*10465441SEvalZero  *
13*10465441SEvalZero  * 1. Redistributions of source code must retain the above copyright notice,
14*10465441SEvalZero  *    this list of conditions and the following disclaimer.
15*10465441SEvalZero  * 2. Redistributions in binary form must reproduce the above copyright notice,
16*10465441SEvalZero  *    this list of conditions and the following disclaimer in the documentation
17*10465441SEvalZero  *    and/or other materials provided with the distribution.
18*10465441SEvalZero  * 3. The name of the author may not be used to endorse or promote products
19*10465441SEvalZero  *    derived from this software without specific prior written permission.
20*10465441SEvalZero  *
21*10465441SEvalZero  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
22*10465441SEvalZero  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
23*10465441SEvalZero  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
24*10465441SEvalZero  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25*10465441SEvalZero  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
26*10465441SEvalZero  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27*10465441SEvalZero  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28*10465441SEvalZero  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
29*10465441SEvalZero  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
30*10465441SEvalZero  * OF SUCH DAMAGE.
31*10465441SEvalZero  *
32*10465441SEvalZero  * This file is part of the lwIP TCP/IP stack.
33*10465441SEvalZero  *
34*10465441SEvalZero  * Author: Erik Ekman <[email protected]>
35*10465441SEvalZero  *
36*10465441SEvalZero  */
37*10465441SEvalZero 
38*10465441SEvalZero #ifndef LWIP_HDR_APPS_MDNS_H
39*10465441SEvalZero #define LWIP_HDR_APPS_MDNS_H
40*10465441SEvalZero 
41*10465441SEvalZero #include "lwip/apps/mdns_opts.h"
42*10465441SEvalZero #include "lwip/netif.h"
43*10465441SEvalZero 
44*10465441SEvalZero #ifdef __cplusplus
45*10465441SEvalZero extern "C" {
46*10465441SEvalZero #endif
47*10465441SEvalZero 
48*10465441SEvalZero #if LWIP_MDNS_RESPONDER
49*10465441SEvalZero 
50*10465441SEvalZero enum mdns_sd_proto {
51*10465441SEvalZero   DNSSD_PROTO_UDP = 0,
52*10465441SEvalZero   DNSSD_PROTO_TCP = 1
53*10465441SEvalZero };
54*10465441SEvalZero 
55*10465441SEvalZero #define MDNS_PROBING_CONFLICT   0
56*10465441SEvalZero #define MDNS_PROBING_SUCCESSFUL 1
57*10465441SEvalZero 
58*10465441SEvalZero #define MDNS_LABEL_MAXLEN  63
59*10465441SEvalZero 
60*10465441SEvalZero struct mdns_host;
61*10465441SEvalZero struct mdns_service;
62*10465441SEvalZero 
63*10465441SEvalZero /** Callback function to add text to a reply, called when generating the reply */
64*10465441SEvalZero typedef void (*service_get_txt_fn_t)(struct mdns_service *service, void *txt_userdata);
65*10465441SEvalZero 
66*10465441SEvalZero /** Callback function to let application know the result of probing network for name
67*10465441SEvalZero  * uniqueness, called with result MDNS_PROBING_SUCCESSFUL if no other node claimed
68*10465441SEvalZero  * use for the name for the netif or a service and is safe to use, or MDNS_PROBING_CONFLICT
69*10465441SEvalZero  * if another node is already using it and mdns is disabled on this interface */
70*10465441SEvalZero typedef void (*mdns_name_result_cb_t)(struct netif* netif, u8_t result);
71*10465441SEvalZero 
72*10465441SEvalZero void mdns_resp_init(void);
73*10465441SEvalZero 
74*10465441SEvalZero void mdns_resp_register_name_result_cb(mdns_name_result_cb_t cb);
75*10465441SEvalZero 
76*10465441SEvalZero err_t mdns_resp_add_netif(struct netif *netif, const char *hostname, u32_t dns_ttl);
77*10465441SEvalZero err_t mdns_resp_remove_netif(struct netif *netif);
78*10465441SEvalZero err_t mdns_resp_rename_netif(struct netif *netif, const char *hostname);
79*10465441SEvalZero 
80*10465441SEvalZero s8_t  mdns_resp_add_service(struct netif *netif, const char *name, const char *service, enum mdns_sd_proto proto, u16_t port, u32_t dns_ttl, service_get_txt_fn_t txt_fn, void *txt_userdata);
81*10465441SEvalZero err_t mdns_resp_del_service(struct netif *netif, s8_t slot);
82*10465441SEvalZero err_t mdns_resp_rename_service(struct netif *netif, s8_t slot, const char *name);
83*10465441SEvalZero 
84*10465441SEvalZero err_t mdns_resp_add_service_txtitem(struct mdns_service *service, const char *txt, u8_t txt_len);
85*10465441SEvalZero 
86*10465441SEvalZero void mdns_resp_restart(struct netif *netif);
87*10465441SEvalZero void mdns_resp_announce(struct netif *netif);
88*10465441SEvalZero 
89*10465441SEvalZero /**
90*10465441SEvalZero  * @ingroup mdns
91*10465441SEvalZero  * Announce IP settings have changed on netif.
92*10465441SEvalZero  * Call this in your callback registered by netif_set_status_callback().
93*10465441SEvalZero  * No need to call this function when LWIP_NETIF_EXT_STATUS_CALLBACK==1,
94*10465441SEvalZero  * this handled automatically for you.
95*10465441SEvalZero  * @param netif The network interface where settings have changed.
96*10465441SEvalZero  */
97*10465441SEvalZero #define mdns_resp_netif_settings_changed(netif) mdns_resp_announce(netif)
98*10465441SEvalZero 
99*10465441SEvalZero #endif /* LWIP_MDNS_RESPONDER */
100*10465441SEvalZero 
101*10465441SEvalZero #ifdef __cplusplus
102*10465441SEvalZero }
103*10465441SEvalZero #endif
104*10465441SEvalZero 
105*10465441SEvalZero #endif /* LWIP_HDR_APPS_MDNS_H */
106