[457] | 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 | *
|
---|
| 36 | */
|
---|
| 37 |
|
---|
| 38 | #ifndef LWIP_HDR_APPS_MDNS_H
|
---|
| 39 | #define LWIP_HDR_APPS_MDNS_H
|
---|
| 40 |
|
---|
| 41 | #include "lwip/apps/mdns_opts.h"
|
---|
| 42 | #include "lwip/netif.h"
|
---|
| 43 |
|
---|
| 44 | #ifdef __cplusplus
|
---|
| 45 | extern "C" {
|
---|
| 46 | #endif
|
---|
| 47 |
|
---|
| 48 | #if LWIP_MDNS_RESPONDER
|
---|
| 49 |
|
---|
| 50 | enum mdns_sd_proto {
|
---|
| 51 | DNSSD_PROTO_UDP = 0,
|
---|
| 52 | DNSSD_PROTO_TCP = 1
|
---|
| 53 | };
|
---|
| 54 |
|
---|
| 55 | #define MDNS_PROBING_CONFLICT 0
|
---|
| 56 | #define MDNS_PROBING_SUCCESSFUL 1
|
---|
| 57 |
|
---|
| 58 | #define MDNS_LABEL_MAXLEN 63
|
---|
| 59 |
|
---|
| 60 | struct mdns_host;
|
---|
| 61 | struct mdns_service;
|
---|
| 62 |
|
---|
| 63 | /** Callback function to add text to a reply, called when generating the reply */
|
---|
| 64 | typedef void (*service_get_txt_fn_t)(struct mdns_service *service, void *txt_userdata);
|
---|
| 65 |
|
---|
| 66 | /** Callback function to let application know the result of probing network for name
|
---|
| 67 | * uniqueness, called with result MDNS_PROBING_SUCCESSFUL if no other node claimed
|
---|
| 68 | * use for the name for the netif or a service and is safe to use, or MDNS_PROBING_CONFLICT
|
---|
| 69 | * if another node is already using it and mdns is disabled on this interface */
|
---|
| 70 | typedef void (*mdns_name_result_cb_t)(struct netif* netif, u8_t result);
|
---|
| 71 |
|
---|
| 72 | void mdns_resp_init(void);
|
---|
| 73 |
|
---|
| 74 | void mdns_resp_register_name_result_cb(mdns_name_result_cb_t cb);
|
---|
| 75 |
|
---|
| 76 | err_t mdns_resp_add_netif(struct netif *netif, const char *hostname, u32_t dns_ttl);
|
---|
| 77 | err_t mdns_resp_remove_netif(struct netif *netif);
|
---|
| 78 | err_t mdns_resp_rename_netif(struct netif *netif, const char *hostname);
|
---|
| 79 |
|
---|
| 80 | 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 | err_t mdns_resp_del_service(struct netif *netif, s8_t slot);
|
---|
| 82 | err_t mdns_resp_rename_service(struct netif *netif, s8_t slot, const char *name);
|
---|
| 83 |
|
---|
| 84 | err_t mdns_resp_add_service_txtitem(struct mdns_service *service, const char *txt, u8_t txt_len);
|
---|
| 85 |
|
---|
| 86 | void mdns_resp_restart(struct netif *netif);
|
---|
| 87 | void mdns_resp_announce(struct netif *netif);
|
---|
| 88 |
|
---|
| 89 | /**
|
---|
| 90 | * @ingroup mdns
|
---|
| 91 | * Announce IP settings have changed on netif.
|
---|
| 92 | * Call this in your callback registered by netif_set_status_callback().
|
---|
| 93 | * No need to call this function when LWIP_NETIF_EXT_STATUS_CALLBACK==1,
|
---|
| 94 | * this handled automatically for you.
|
---|
| 95 | * @param netif The network interface where settings have changed.
|
---|
| 96 | */
|
---|
| 97 | #define mdns_resp_netif_settings_changed(netif) mdns_resp_announce(netif)
|
---|
| 98 |
|
---|
| 99 | #endif /* LWIP_MDNS_RESPONDER */
|
---|
| 100 |
|
---|
| 101 | #ifdef __cplusplus
|
---|
| 102 | }
|
---|
| 103 | #endif
|
---|
| 104 |
|
---|
| 105 | #endif /* LWIP_HDR_APPS_MDNS_H */
|
---|