Internet Middleware API Reference  Rev 1.0
DHCPD

This section introduces the DHCP daemon (DHCPD) APIs including details on how to use this module, structures and functions. More...

Overview

This section introduces the DHCP daemon (DHCPD) APIs including details on how to use this module, structures and functions.

It's a simple DHCP daemon to operate in soft AP mode for assigning IP addresses to connected Wi-Fi station nodes.

Terms and acronyms

Terms Details
DHCP Dynamic Host Configuration Protocol.
Wi-Fi Wi-Fi is a local area wireless computer networking technology, https://en.wikipedia.org/wiki/Wi-Fi

How to use this module

Functions

int dhcpd_start (dhcpd_settings_t *dhcpd_settings)
 This function is used to start the DHCPD service. More...
 
void dhcpd_stop (void)
 This function is used to stop the DHCPD service. More...
 

Modules

 Define
 
 Struct
 

Function Documentation

int dhcpd_start ( dhcpd_settings_t dhcpd_settings)

This function is used to start the DHCPD service.

It creates a new task for the DHCPD, then returns. The DHCPD task runs until dhcpd_stop() is called.

Parameters
[in]dhcpd_settingsspecifies the settings for DHCPD, such as DHCP server IP, gateway, netmask, DNS and IP pool. These settings can be set individually. If the setting is not set, default value will be used. Please beware that if both default values and customer configured value are used, they should match to each other.
Returns
See also
dhcpd_stop();
void dhcpd_stop ( void  )

This function is used to stop the DHCPD service.

It kills the DHCPD task and stops the DHCPD service immediately.

Returns
See also
dhcpd_start();