Documentation

Documentation

Includes

lwip/opt.h

#include "lwip/opt.h"
#include "lwip/opt.h"

lwip/ip_addr.h

#include "lwip/ip_addr.h"
#include "lwip/ip_addr.h"

lwip/err.h

#include "lwip/err.h"
#include "lwip/err.h"

Macros

Marco LWIP_HDR_DNS_H

#define LWIP_HDR_DNS_H


      

Marco DNS_TMR_INTERVAL

#define DNS_TMR_INTERVAL         1000
/** DNS timer period */

Marco LWIP_DNS_ADDRTYPE_IPV4

#define LWIP_DNS_ADDRTYPE_IPV4     0
/* DNS resolve types: */

Marco LWIP_DNS_ADDRTYPE_IPV6

#define LWIP_DNS_ADDRTYPE_IPV6     1


      

Marco LWIP_DNS_ADDRTYPE_IPV4_IPV6

#define LWIP_DNS_ADDRTYPE_IPV4_IPV6 2 /* try to resolve IPv4 first, try IPv6 if IPv4 fails only */


      

Marco LWIP_DNS_ADDRTYPE_IPV6_IPV4

#define LWIP_DNS_ADDRTYPE_IPV6_IPV4 3 /* try to resolve IPv6 first, try IPv4 if IPv6 fails only */


      

Marco LWIP_DNS_ADDRTYPE_DEFAULT

#define LWIP_DNS_ADDRTYPE_DEFAULT  LWIP_DNS_ADDRTYPE_IPV4_IPV6


      

Marco LWIP_DNS_ADDRTYPE_DEFAULT

#define LWIP_DNS_ADDRTYPE_DEFAULT  LWIP_DNS_ADDRTYPE_IPV4


      

Marco LWIP_DNS_ADDRTYPE_DEFAULT

#define LWIP_DNS_ADDRTYPE_DEFAULT  LWIP_DNS_ADDRTYPE_IPV6


      

Marco DNS_LOCAL_HOSTLIST_ELEM(name, addr_init)

#define DNS_LOCAL_HOSTLIST_ELEM(name, addr_init) {name, addr_init, NULL}


      

Marco DNS_LOCAL_HOSTLIST_MAX_NAMELEN

#define DNS_LOCAL_HOSTLIST_MAX_NAMELEN DNS_MAX_NAME_LENGTH


      

Marco LOCALHOSTLIST_ELEM_SIZE

#define LOCALHOSTLIST_ELEM_SIZE ((sizeof(struct local_hostlist_entry) + DNS_LOCAL_HOSTLIST_MAX_NAMELEN + 1))

      

Functions

Func dns_init

void            dns_init(void);


      

Func dns_tmr

void            dns_tmr(void);


      

Func dns_setserver

void            dns_setserver(u8_t numdns, const ip_addr_t *dnsserver);


      

Func dns_gethostbyname

err_t           dns_gethostbyname(const char *hostname, ip_addr_t *addr,
                                  dns_found_callback found, void *callback_arg);


      

Func dns_gethostbyname_addrtype

err_t           dns_gethostbyname_addrtype(const char *hostname, ip_addr_t *addr,
                                  dns_found_callback found, void *callback_arg,
                                  u8_t dns_addrtype);


      

Func dns_local_iterate

size_t        dns_local_iterate(dns_found_callback iterator_fn, void *iterator_arg);


      

Func dns_local_lookup

err_t         dns_local_lookup(const char *hostname, ip_addr_t *addr, u8_t dns_addrtype);


      

Func dns_local_removehost

int           dns_local_removehost(const char *hostname, const ip_addr_t *addr);


      

Func dns_local_addhost

err_t         dns_local_addhost(const char *hostname, const ip_addr_t *addr);

      

Vars

Consts

Const

const ip_addr_t* dns_getserver(u8_t numdns);

      

Types

Typedefs

Typedef dns_found_callback

typedef void (*dns_found_callback)(const char *name, const ip_addr_t *ipaddr, void *callback_arg);
/** Callback which is invoked when a hostname is found.
 * A function of this type must be implemented by the application using the DNS resolver.
 * @param name pointer to the name that was looked up.
 * @param ipaddr pointer to an ip_addr_t containing the IP address of the hostname,
 *        or NULL if the name could not be found (or on any other error).
 * @param callback_arg a user-specified callback argument passed to dns_gethostbyname
*/