Add a dynamically-configured IP host address, subnet mask, and default gateway to an interface.
Files
net_ip.h/net_ip.c
Prototype
Arguments
if_nbr
Interface number to configure.
addr_host
Desired IP IPv4 address to add to this interface.
addr_subnet_mask
Desired IP IPv4 address subnet mask.
addr_dflt_gateway
Desired IP IPv4 default gateway address.
perr
Pointer to variable that will receive the return error code from this function:
NET_IPIPv4_ERR_NONE
NET_IPIPv4_ERR_INVALID_ADDR_HOST
NET_IPIPv4_ERR_INVALID_ADDR_GATEWAY
NET_IPIPv4_ERR_ADDR_CFG_STATE
NET_IPIPv4_ERR_ADDR_CFG_IN_USE
NET_IF_ERR_INVALID_IF
NET_ERR_INIT_INCOMPLETE
NET_OS_ERR_LOCK
Returned Value
DEF_OK,
if valid IP IPv4 address, subnet mask, and default gateway dynamically configured;
DEF_FAIL,
otherwise.
Required Configuration
None.
Notes / Warnings
IP IPv4 addresses must be configured in host-order.
...
- One or more statically- configured IP IPv4 addresses (see section C-12-1) or
- Exactly one dynamically-configured IP IPv4 address.
This function should only be called by appropriate network application function(s) [e.g., DHCP initialization functions]. However, if the application attempts to dynamically configure IP IPv4 address(es), it must call NetIPNetIPv4_CfgAddrAddDynamicStart() before calling NetIPNetIPv4_CfgAddrAddDynamic(). Note that on the default interface, the first IP IPv4 address added will be the default address used for all default communication. See also section C-9-1.
A host may be configured without a gateway address to allow communication only with other hosts on its local network. However, any configured gateway address must be on the same network as the configured host IP IPv4 address (i.e., the network portion of the configured IP IPv4 address and the configured gateway addresses must be identical).