mbed unsupported / lwip

A version of LWIP, provided for backwards compatibility.

Dependents:   AA_DemoBoard DemoBoard HelloServerDemo DemoBoard_RangeIndicator ... more

Embed: (wiki syntax)

« Back to documentation index

dhcp.h File Reference
Data Structures | Functions

dhcp.h File Reference

Go to the source code of this file.

Data Structures

struct  dhcp_msg
 minimum set of fields of any DHCP message More...

Functions

PACK_STRUCT_END err_t dhcp_start (struct netif *netif)
 start DHCP configuration
err_t dhcp_renew (struct netif *netif)
 enforce early lease renewal (not needed normally)
err_t dhcp_release (struct netif *netif)
 release the DHCP lease, usually called before dhcp_stop()
void dhcp_stop (struct netif *netif)
 stop DHCP configuration
void dhcp_inform (struct netif *netif)
 inform server of our manual IP address
void dhcp_arp_reply (struct netif *netif, struct ip_addr *addr)
 if enabled, check whether the offered IP address is not in use, using ARP
void dhcp_coarse_tmr (void)
 to be called every minute
void dhcp_fine_tmr (void)
 to be called every half second

Detailed Description

Definition in file tag/13/Core/lwIP/include/lwip/dhcp.h.

Function Documentation

void dhcp_arp_reply ( struct netif *  netif,
struct ip_addr *  addr 
)

if enabled, check whether the offered IP address is not in use, using ARP

if enabled, check whether the offered IP address is not in use, using ARP

Parameters:
netifthe network interface on which the reply was received
addrThe IP address we received a reply from

Definition at line 688 of file tag/0.2/lwIP/core/dhcp.c.

void dhcp_coarse_tmr (  )

to be called every minute

Definition at line 303 of file tag/0.2/lwIP/core/dhcp.c.

void dhcp_fine_tmr (  )

to be called every half second

to be called every half second

A DHCP server is expected to respond within a short period of time. This timer checks whether an outstanding DHCP request is timed out.

Definition at line 336 of file tag/0.2/lwIP/core/dhcp.c.

void dhcp_inform ( struct netif *  netif )

inform server of our manual IP address

inform server of our manual IP address

This informs DHCP servers of our fixed IP address configuration by sending an INFORM message. It does not involve DHCP address configuration, it is just here to be nice to the network.

Parameters:
netifThe lwIP network interface

Definition at line 626 of file tag/0.2/lwIP/core/dhcp.c.

err_t dhcp_release ( struct netif *  netif )

release the DHCP lease, usually called before dhcp_stop()

release the DHCP lease, usually called before dhcp_stop()

Parameters:
netifnetwork interface which must release its lease

Definition at line 1008 of file tag/0.2/lwIP/core/dhcp.c.

err_t dhcp_renew ( struct netif *  netif )

enforce early lease renewal (not needed normally)

enforce early lease renewal (not needed normally)

Parameters:
netifnetwork interface which must renew its lease

Definition at line 902 of file tag/0.2/lwIP/core/dhcp.c.

PACK_STRUCT_END err_t dhcp_start ( struct netif *  netif )

start DHCP configuration

start DHCP configuration

If no DHCP client instance was attached to this interface, a new client is created first. If a DHCP client instance was already present, it restarts negotiation.

Parameters:
netifThe lwIP network interface
Returns:
lwIP error code
  • ERR_OK - No error
  • ERR_MEM - Out of memory

Definition at line 563 of file tag/0.2/lwIP/core/dhcp.c.

void dhcp_stop ( struct netif *  netif )

stop DHCP configuration

stop DHCP configuration

Parameters:
netifThe network interface to stop DHCP on

Definition at line 1062 of file tag/0.2/lwIP/core/dhcp.c.

Generated on Tue Jul 12 2022 16:06:28 by  doxygen 1.7.2