Documentation

Documentation

Includes

lwip/opt.h

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

lwip/netif.h

#include "lwip/netif.h"
#include "lwip/netif.h"

lwip/udp.h

#include "lwip/udp.h"
#include "lwip/udp.h"

Macros

Marco LWIP_HDR_DHCP_H

#define LWIP_HDR_DHCP_H


      

Marco DHCP_COARSE_TIMER_SECS

#define DHCP_COARSE_TIMER_SECS 60


      

Marco DHCP_COARSE_TIMER_MSECS

#define DHCP_COARSE_TIMER_MSECS (DHCP_COARSE_TIMER_SECS * 1000UL)
/** period (in milliseconds) of the application calling dhcp_coarse_tmr() */

Marco DHCP_FINE_TIMER_MSECS

#define DHCP_FINE_TIMER_MSECS  500
/** period (in milliseconds) of the application calling dhcp_fine_tmr() */

Marco DHCP_BOOT_FILE_LEN

#define DHCP_BOOT_FILE_LEN     128U


      

Marco dhcp_remove_struct(netif)

#define dhcp_remove_struct(netif) netif_set_client_data(netif, LWIP_NETIF_CLIENT_DATA_INDEX_DHCP, NULL)
/** Remove a struct dhcp previously set to the netif using dhcp_set_struct() */

Marco netif_dhcp_data(netif)

#define netif_dhcp_data(netif) ((struct dhcp*)netif_get_client_data(netif, LWIP_NETIF_CLIENT_DATA_INDEX_DHCP))

      

Functions

Func dhcp_set_struct

void dhcp_set_struct(struct netif *netif, struct dhcp *dhcp);


      

Func dhcp_cleanup

void dhcp_cleanup(struct netif *netif);


      

Func dhcp_start

err_t dhcp_start(struct netif *netif);


      

Func dhcp_renew

err_t dhcp_renew(struct netif *netif);


      

Func dhcp_release

err_t dhcp_release(struct netif *netif);


      

Func dhcp_stop

void dhcp_stop(struct netif *netif);


      

Func dhcp_release_and_stop

void dhcp_release_and_stop(struct netif *netif);


      

Func dhcp_inform

void dhcp_inform(struct netif *netif);


      

Func dhcp_network_changed

void dhcp_network_changed(struct netif *netif);


      

Func dhcp_arp_reply

void dhcp_arp_reply(struct netif *netif, const ip4_addr_t *addr);


      

Func dhcp_supplied_address

u8_t dhcp_supplied_address(const struct netif *netif);


      

Func dhcp_coarse_tmr

void dhcp_coarse_tmr(void);
/* to be called every minute */

Func dhcp_fine_tmr

void dhcp_fine_tmr(void);
/* to be called every half second */

Vars

Consts

Types

Typedefs

Typedef dhcp_autoip_coop_state_enum_t;

typedef enum {
 DHCP_AUTOIP_COOP_STATE_OFF = 0,
 DHCP_AUTOIP_COOP_STATE_ON  = 1
} dhcp_autoip_coop_state_enum_t;
/* AutoIP cooperation flags (struct dhcp.autoip_coop_state) */