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 address to add to this interface.
addr_subnet_mask
Desired IP address subnet mask.
addr_dflt_gateway
Desired IP default gateway address.
perr
Pointer to variable that will receive the return error code from this function:
NET_IP_ERR_NONE
NET_IP_ERR_INVALID_ADDR_HOST
NET_IP_ERR_INVALID_ADDR_GATEWAY
NET_IP_ERR_ADDR_CFG_STATE
NET_IP_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 address, subnet mask, and default gateway dynamically configured;
DEF_FAIL
,
otherwise.
Required Configuration
None.
Notes / Warnings
IP addresses must be configured in host-order.
An interface may be configured with either:
- One or more statically- configured IP addresses (see section C-12-1) or
- Exactly one dynamically-configured IP 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 address(es), it must call NetIP_CfgAddrAddDynamicStart()
before calling NetIP_CfgAddrAddDynamic()
. Note that on the default interface, the first IP 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 address (i.e., the network portion of the configured IP address and the configured gateway addresses must be identical).