Donatien Garnier
NetServices Stack source
Dependents: HelloWorld ServoInterfaceBoardExample1 4180_Lab4
lwip/include/lwip/dns.h@5:dd63a1e02b1b, 2010-07-27 (annotated)
- Committer:
- donatien
- Date:
- Tue Jul 27 15:59:42 2010 +0000
- Revision:
- 5:dd63a1e02b1b
- Parent:
- 2:a4f97773c90f
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| donatien | 5:dd63a1e02b1b | 1 | /** |
| donatien | 5:dd63a1e02b1b | 2 | * lwip DNS resolver header file. |
| donatien | 5:dd63a1e02b1b | 3 | |
| donatien | 5:dd63a1e02b1b | 4 | * Author: Jim Pettinato |
| donatien | 5:dd63a1e02b1b | 5 | * April 2007 |
| donatien | 5:dd63a1e02b1b | 6 | |
| donatien | 5:dd63a1e02b1b | 7 | * ported from uIP resolv.c Copyright (c) 2002-2003, Adam Dunkels. |
| donatien | 5:dd63a1e02b1b | 8 | * |
| donatien | 5:dd63a1e02b1b | 9 | * Redistribution and use in source and binary forms, with or without |
| donatien | 5:dd63a1e02b1b | 10 | * modification, are permitted provided that the following conditions |
| donatien | 5:dd63a1e02b1b | 11 | * are met: |
| donatien | 5:dd63a1e02b1b | 12 | * 1. Redistributions of source code must retain the above copyright |
| donatien | 5:dd63a1e02b1b | 13 | * notice, this list of conditions and the following disclaimer. |
| donatien | 5:dd63a1e02b1b | 14 | * 2. Redistributions in binary form must reproduce the above copyright |
| donatien | 5:dd63a1e02b1b | 15 | * notice, this list of conditions and the following disclaimer in the |
| donatien | 5:dd63a1e02b1b | 16 | * documentation and/or other materials provided with the distribution. |
| donatien | 5:dd63a1e02b1b | 17 | * 3. The name of the author may not be used to endorse or promote |
| donatien | 5:dd63a1e02b1b | 18 | * products derived from this software without specific prior |
| donatien | 5:dd63a1e02b1b | 19 | * written permission. |
| donatien | 5:dd63a1e02b1b | 20 | * |
| donatien | 5:dd63a1e02b1b | 21 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS |
| donatien | 5:dd63a1e02b1b | 22 | * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
| donatien | 5:dd63a1e02b1b | 23 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| donatien | 5:dd63a1e02b1b | 24 | * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY |
| donatien | 5:dd63a1e02b1b | 25 | * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| donatien | 5:dd63a1e02b1b | 26 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE |
| donatien | 5:dd63a1e02b1b | 27 | * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| donatien | 5:dd63a1e02b1b | 28 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, |
| donatien | 5:dd63a1e02b1b | 29 | * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING |
| donatien | 5:dd63a1e02b1b | 30 | * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
| donatien | 5:dd63a1e02b1b | 31 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| donatien | 5:dd63a1e02b1b | 32 | */ |
| donatien | 5:dd63a1e02b1b | 33 | |
| donatien | 5:dd63a1e02b1b | 34 | #ifndef __LWIP_DNS_H__ |
| donatien | 5:dd63a1e02b1b | 35 | #define __LWIP_DNS_H__ |
| donatien | 5:dd63a1e02b1b | 36 | |
| donatien | 5:dd63a1e02b1b | 37 | #include "lwip/opt.h" |
| donatien | 5:dd63a1e02b1b | 38 | |
| donatien | 5:dd63a1e02b1b | 39 | #if LWIP_DNS /* don't build if not configured for use in lwipopts.h */ |
| donatien | 5:dd63a1e02b1b | 40 | |
| donatien | 5:dd63a1e02b1b | 41 | /** DNS timer period */ |
| donatien | 5:dd63a1e02b1b | 42 | #define DNS_TMR_INTERVAL 1000 |
| donatien | 5:dd63a1e02b1b | 43 | |
| donatien | 5:dd63a1e02b1b | 44 | /** DNS field TYPE used for "Resource Records" */ |
| donatien | 5:dd63a1e02b1b | 45 | #define DNS_RRTYPE_A 1 /* a host address */ |
| donatien | 5:dd63a1e02b1b | 46 | #define DNS_RRTYPE_NS 2 /* an authoritative name server */ |
| donatien | 5:dd63a1e02b1b | 47 | #define DNS_RRTYPE_MD 3 /* a mail destination (Obsolete - use MX) */ |
| donatien | 5:dd63a1e02b1b | 48 | #define DNS_RRTYPE_MF 4 /* a mail forwarder (Obsolete - use MX) */ |
| donatien | 5:dd63a1e02b1b | 49 | #define DNS_RRTYPE_CNAME 5 /* the canonical name for an alias */ |
| donatien | 5:dd63a1e02b1b | 50 | #define DNS_RRTYPE_SOA 6 /* marks the start of a zone of authority */ |
| donatien | 5:dd63a1e02b1b | 51 | #define DNS_RRTYPE_MB 7 /* a mailbox domain name (EXPERIMENTAL) */ |
| donatien | 5:dd63a1e02b1b | 52 | #define DNS_RRTYPE_MG 8 /* a mail group member (EXPERIMENTAL) */ |
| donatien | 5:dd63a1e02b1b | 53 | #define DNS_RRTYPE_MR 9 /* a mail rename domain name (EXPERIMENTAL) */ |
| donatien | 5:dd63a1e02b1b | 54 | #define DNS_RRTYPE_NULL 10 /* a null RR (EXPERIMENTAL) */ |
| donatien | 5:dd63a1e02b1b | 55 | #define DNS_RRTYPE_WKS 11 /* a well known service description */ |
| donatien | 5:dd63a1e02b1b | 56 | #define DNS_RRTYPE_PTR 12 /* a domain name pointer */ |
| donatien | 5:dd63a1e02b1b | 57 | #define DNS_RRTYPE_HINFO 13 /* host information */ |
| donatien | 5:dd63a1e02b1b | 58 | #define DNS_RRTYPE_MINFO 14 /* mailbox or mail list information */ |
| donatien | 5:dd63a1e02b1b | 59 | #define DNS_RRTYPE_MX 15 /* mail exchange */ |
| donatien | 5:dd63a1e02b1b | 60 | #define DNS_RRTYPE_TXT 16 /* text strings */ |
| donatien | 5:dd63a1e02b1b | 61 | |
| donatien | 5:dd63a1e02b1b | 62 | /** DNS field CLASS used for "Resource Records" */ |
| donatien | 5:dd63a1e02b1b | 63 | #define DNS_RRCLASS_IN 1 /* the Internet */ |
| donatien | 5:dd63a1e02b1b | 64 | #define DNS_RRCLASS_CS 2 /* the CSNET class (Obsolete - used only for examples in some obsolete RFCs) */ |
| donatien | 5:dd63a1e02b1b | 65 | #define DNS_RRCLASS_CH 3 /* the CHAOS class */ |
| donatien | 5:dd63a1e02b1b | 66 | #define DNS_RRCLASS_HS 4 /* Hesiod [Dyer 87] */ |
| donatien | 5:dd63a1e02b1b | 67 | #define DNS_RRCLASS_FLUSH 0x800 /* Flush bit */ |
| donatien | 5:dd63a1e02b1b | 68 | |
| donatien | 5:dd63a1e02b1b | 69 | /* The size used for the next line is rather a hack, but it prevents including socket.h in all files |
| donatien | 5:dd63a1e02b1b | 70 | that include memp.h, and that would possibly break portability (since socket.h defines some types |
| donatien | 5:dd63a1e02b1b | 71 | and constants possibly already define by the OS). |
| donatien | 5:dd63a1e02b1b | 72 | Calculation rule: |
| donatien | 5:dd63a1e02b1b | 73 | sizeof(struct addrinfo) + sizeof(struct sockaddr_in) + DNS_MAX_NAME_LENGTH + 1 byte zero-termination */ |
| donatien | 5:dd63a1e02b1b | 74 | #define NETDB_ELEM_SIZE (32 + 16 + DNS_MAX_NAME_LENGTH + 1) |
| donatien | 5:dd63a1e02b1b | 75 | |
| donatien | 5:dd63a1e02b1b | 76 | #if DNS_LOCAL_HOSTLIST |
| donatien | 5:dd63a1e02b1b | 77 | /** struct used for local host-list */ |
| donatien | 5:dd63a1e02b1b | 78 | struct local_hostlist_entry { |
| donatien | 5:dd63a1e02b1b | 79 | /** static hostname */ |
| donatien | 5:dd63a1e02b1b | 80 | const char *name; |
| donatien | 5:dd63a1e02b1b | 81 | /** static host address in network byteorder */ |
| donatien | 5:dd63a1e02b1b | 82 | ip_addr_t addr; |
| donatien | 5:dd63a1e02b1b | 83 | struct local_hostlist_entry *next; |
| donatien | 5:dd63a1e02b1b | 84 | }; |
| donatien | 5:dd63a1e02b1b | 85 | #if DNS_LOCAL_HOSTLIST_IS_DYNAMIC |
| donatien | 5:dd63a1e02b1b | 86 | #ifndef DNS_LOCAL_HOSTLIST_MAX_NAMELEN |
| donatien | 5:dd63a1e02b1b | 87 | #define DNS_LOCAL_HOSTLIST_MAX_NAMELEN DNS_MAX_NAME_LENGTH |
| donatien | 5:dd63a1e02b1b | 88 | #endif |
| donatien | 5:dd63a1e02b1b | 89 | #define LOCALHOSTLIST_ELEM_SIZE ((sizeof(struct local_hostlist_entry) + DNS_LOCAL_HOSTLIST_MAX_NAMELEN + 1)) |
| donatien | 5:dd63a1e02b1b | 90 | #endif /* DNS_LOCAL_HOSTLIST_IS_DYNAMIC */ |
| donatien | 5:dd63a1e02b1b | 91 | #endif /* DNS_LOCAL_HOSTLIST */ |
| donatien | 5:dd63a1e02b1b | 92 | |
| donatien | 5:dd63a1e02b1b | 93 | /** Callback which is invoked when a hostname is found. |
| donatien | 5:dd63a1e02b1b | 94 | * A function of this type must be implemented by the application using the DNS resolver. |
| donatien | 5:dd63a1e02b1b | 95 | * @param name pointer to the name that was looked up. |
| donatien | 5:dd63a1e02b1b | 96 | * @param ipaddr pointer to an ip_addr_t containing the IP address of the hostname, |
| donatien | 5:dd63a1e02b1b | 97 | * or NULL if the name could not be found (or on any other error). |
| donatien | 5:dd63a1e02b1b | 98 | * @param callback_arg a user-specified callback argument passed to dns_gethostbyname |
| donatien | 5:dd63a1e02b1b | 99 | */ |
| donatien | 5:dd63a1e02b1b | 100 | typedef void (*dns_found_callback)(const char *name, ip_addr_t *ipaddr, void *callback_arg); |
| donatien | 5:dd63a1e02b1b | 101 | |
| donatien | 5:dd63a1e02b1b | 102 | void dns_init(void); |
| donatien | 5:dd63a1e02b1b | 103 | void dns_tmr(void); |
| donatien | 5:dd63a1e02b1b | 104 | void dns_setserver(u8_t numdns, ip_addr_t *dnsserver); |
| donatien | 5:dd63a1e02b1b | 105 | ip_addr_t dns_getserver(u8_t numdns); |
| donatien | 5:dd63a1e02b1b | 106 | err_t dns_gethostbyname(const char *hostname, ip_addr_t *addr, |
| donatien | 5:dd63a1e02b1b | 107 | dns_found_callback found, void *callback_arg); |
| donatien | 5:dd63a1e02b1b | 108 | |
| donatien | 5:dd63a1e02b1b | 109 | #if DNS_LOCAL_HOSTLIST && DNS_LOCAL_HOSTLIST_IS_DYNAMIC |
| donatien | 5:dd63a1e02b1b | 110 | int dns_local_removehost(const char *hostname, const ip_addr_t *addr); |
| donatien | 5:dd63a1e02b1b | 111 | err_t dns_local_addhost(const char *hostname, const ip_addr_t *addr); |
| donatien | 5:dd63a1e02b1b | 112 | #endif /* DNS_LOCAL_HOSTLIST && DNS_LOCAL_HOSTLIST_IS_DYNAMIC */ |
| donatien | 5:dd63a1e02b1b | 113 | |
| donatien | 5:dd63a1e02b1b | 114 | #endif /* LWIP_DNS */ |
| donatien | 5:dd63a1e02b1b | 115 | |
| donatien | 5:dd63a1e02b1b | 116 | #endif /* __LWIP_DNS_H__ */ |