1 /** 2 * @file 3 * MDNS responder 4 */ 5 6 /* 7 * Copyright (c) 2015 Verisure Innovation AB 8 * All rights reserved. 9 * 10 * Redistribution and use in source and binary forms, with or without modification, 11 * are permitted provided that the following conditions are met: 12 * 13 * 1. Redistributions of source code must retain the above copyright notice, 14 * this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright notice, 16 * this list of conditions and the following disclaimer in the documentation 17 * and/or other materials provided with the distribution. 18 * 3. The name of the author may not be used to endorse or promote products 19 * derived from this software without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 22 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 23 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 24 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 26 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 29 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 30 * OF SUCH DAMAGE. 31 * 32 * This file is part of the lwIP TCP/IP stack. 33 * 34 * Author: Erik Ekman <erik@kryo.se> 35 * Author: Jasper Verschueren <jasper.verschueren@apart-audio.com> 36 * 37 */ 38 39 #ifndef LWIP_HDR_APPS_MDNS_H 40 #define LWIP_HDR_APPS_MDNS_H 41 42 #include "lwip/apps/mdns_opts.h" 43 #include "lwip/netif.h" 44 45 #ifdef __cplusplus 46 extern "C" { 47 #endif 48 49 #if LWIP_MDNS_RESPONDER 50 51 enum mdns_sd_proto { 52 DNSSD_PROTO_UDP = 0, 53 DNSSD_PROTO_TCP = 1 54 }; 55 56 #define MDNS_PROBING_CONFLICT 0 57 #define MDNS_PROBING_SUCCESSFUL 1 58 59 #define MDNS_LABEL_MAXLEN 63 60 #define MDNS_DOMAIN_MAXLEN 256 61 62 struct mdns_host; 63 struct mdns_service; 64 65 /* Domain structs */ 66 struct mdns_domain { 67 /* Encoded domain name */ 68 u8_t name[MDNS_DOMAIN_MAXLEN]; 69 /* Total length of domain name, including zero */ 70 u16_t length; 71 /* Set if compression of this domain is not allowed */ 72 u8_t skip_compression; 73 }; 74 75 /** Domain, type and class. 76 * Shared between questions and answers */ 77 struct mdns_rr_info { 78 struct mdns_domain domain; 79 u16_t type; 80 u16_t klass; 81 }; 82 83 struct mdns_answer { 84 struct mdns_rr_info info; 85 /** cache flush command bit */ 86 u16_t cache_flush; 87 /* Validity time in seconds */ 88 u32_t ttl; 89 /** Length of variable answer */ 90 u16_t rd_length; 91 /** Offset of start of variable answer in packet */ 92 u16_t rd_offset; 93 }; 94 95 /** Callback function to add text to a reply, called when generating the reply */ 96 typedef void (*service_get_txt_fn_t)(struct mdns_service *service, void *txt_userdata); 97 98 /** Callback function to let application know the result of probing network for name 99 * uniqueness, called with result MDNS_PROBING_SUCCESSFUL if no other node claimed 100 * use for the name for the netif or a service and is safe to use, or MDNS_PROBING_CONFLICT 101 * if another node is already using it and mdns is disabled on this interface */ 102 typedef void (*mdns_name_result_cb_t)(struct netif* netif, u8_t result, s8_t slot); 103 104 void *mdns_get_service_txt_userdata(struct netif *netif, s8_t slot); 105 106 void mdns_resp_init(void); 107 108 void mdns_resp_register_name_result_cb(mdns_name_result_cb_t cb); 109 110 err_t mdns_resp_add_netif(struct netif *netif, const char *hostname); 111 err_t mdns_resp_remove_netif(struct netif *netif); 112 err_t mdns_resp_rename_netif(struct netif *netif, const char *hostname); 113 int mdns_resp_netif_active(struct netif *netif); 114 115 s8_t mdns_resp_add_service(struct netif *netif, const char *name, const char *service, enum mdns_sd_proto proto, u16_t port, service_get_txt_fn_t txt_fn, void *txt_userdata); 116 err_t mdns_resp_del_service(struct netif *netif, u8_t slot); 117 err_t mdns_resp_rename_service(struct netif *netif, u8_t slot, const char *name); 118 119 err_t mdns_resp_add_service_txtitem(struct mdns_service *service, const char *txt, u8_t txt_len); 120 121 void mdns_resp_restart_delay(struct netif *netif, uint32_t delay); 122 void mdns_resp_restart(struct netif *netif); 123 void mdns_resp_announce(struct netif *netif); 124 125 /** 126 * @ingroup mdns 127 * Announce IP settings have changed on netif. 128 * Call this in your callback registered by netif_set_status_callback(). 129 * No need to call this function when LWIP_NETIF_EXT_STATUS_CALLBACK==1, 130 * this handled automatically for you. 131 * @param netif The network interface where settings have changed. 132 */ 133 #define mdns_resp_netif_settings_changed(netif) mdns_resp_announce(netif) 134 135 #if LWIP_MDNS_SEARCH 136 typedef void (*search_result_fn_t)(struct mdns_answer *answer, const char *varpart, int varlen, int flags, void *arg); 137 /* flags bits, both can be set! */ 138 #define MDNS_SEARCH_RESULT_FIRST 1 /* First answer in received frame. */ 139 #define MDNS_SEARCH_RESULT_LAST 2 /* Last answer. */ 140 141 err_t mdns_search_service(const char *name, const char *service, enum mdns_sd_proto proto, 142 struct netif *netif, search_result_fn_t result_fn, void *arg, 143 u8_t *request_id); 144 void mdns_search_stop(u8_t request_id); 145 146 #endif /* LWIP_MDNS_SEARCH */ 147 148 #endif /* LWIP_MDNS_RESPONDER */ 149 150 #ifdef __cplusplus 151 } 152 #endif 153 154 #endif /* LWIP_HDR_APPS_MDNS_H */ 155