xref: /btstack/3rd-party/lwip/core/src/include/lwip/apps/mdns_domain.h (revision 97dc5e692c7d94a280158af58036a0efee5b0e56)
1 /**
2  * @file
3  * MDNS responder - domain related functionalities
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 <[email protected]>
35  * Author: Jasper Verschueren <[email protected]>
36  *
37  */
38 
39 #ifndef LWIP_HDR_APPS_MDNS_DOMAIN_H
40 #define LWIP_HDR_APPS_MDNS_DOMAIN_H
41 
42 #include "lwip/apps/mdns_opts.h"
43 #include "lwip/apps/mdns_priv.h"
44 
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48 
49 #if LWIP_MDNS_RESPONDER
50 
51 /* Domain methods - also visible for unit tests */
52 
53 err_t mdns_domain_add_label(struct mdns_domain *domain, const char *label, u8_t len);
54 err_t mdns_domain_add_domain(struct mdns_domain *domain, struct mdns_domain *source);
55 err_t mdns_domain_add_string(struct mdns_domain *domain, const char *source);
56 u16_t mdns_readname(struct pbuf *p, u16_t offset, struct mdns_domain *domain);
57 void mdns_domain_debug_print(struct mdns_domain *domain);
58 int mdns_domain_eq(struct mdns_domain *a, struct mdns_domain *b);
59 #if LWIP_IPV4
60 err_t mdns_build_reverse_v4_domain(struct mdns_domain *domain, const ip4_addr_t *addr);
61 #endif
62 #if LWIP_IPV6
63 err_t mdns_build_reverse_v6_domain(struct mdns_domain *domain, const ip6_addr_t *addr);
64 #endif
65 err_t mdns_build_host_domain(struct mdns_domain *domain, struct mdns_host *mdns);
66 err_t mdns_build_dnssd_domain(struct mdns_domain *domain);
67 err_t mdns_build_service_domain(struct mdns_domain *domain, struct mdns_service *service, int include_name);
68 #if LWIP_MDNS_SEARCH
69 err_t mdns_build_request_domain(struct mdns_domain *domain, struct mdns_request *request, int include_name);
70 #endif
71 u16_t mdns_compress_domain(struct pbuf *pbuf, u16_t *offset, struct mdns_domain *domain);
72 err_t mdns_write_domain(struct mdns_outpacket *outpkt, struct mdns_domain *domain);
73 
74 #endif /* LWIP_MDNS_RESPONDER */
75 
76 #ifdef __cplusplus
77 }
78 #endif
79 
80 #endif /* LWIP_HDR_APPS_MDNS_DOMAIN_H */
81