Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Function nameDescription
IPv4

NetIPv4_CfgAddrAdd

Add a statically-configured IPv4 host address, subnet mask, and default gateway to an interface.
NetIPv4_CfgAddrRemove  Remove a configured IPv4 host address from an interface.
NetIPv4_CfgAddrRemoveAll  Remove all configured IPv4 host address(es) from an interface.
IPv6
NetIPv6_AddrAutoCfgEnEnable the IPv6 Stateless Address Auto-Configuration procedure.
NetIPv6_AddrAutoCfgDisDisable the IPv6 Stateless Address Auto-Configuration procedure.
NetIPv6_AddrAutoCfgHookSetSet the hook function to received the IPv6 Stateless Address Auto-Configuration process result.
NetIPv6_CfgAddrAdd Add a statically-configured IPv6 host address to an interface.
NetIPv6_CfgAddrHookSetSet the hook function to received the IPv6 Static Address Configuration process result.
NetIPv6_CfgAddrRemove Remove a configured IPv6 host address & multicast solicited mode address from an interface.
NetIPv6_CfgAddrRemoveAll Remove all configured IPv6 host address(es) from an interface.

Interface Configured IP Address Functions

...

Function NameDescription
IPv4
NetIPv4_GetAddrHost Get an interface’s configured IPv4 host address(es).
NetIPv4_GetAddrSrc Get corresponding configured IPv4 host address to use as source address for a remote IPv4 address.
NetIPv4_GetAddrDfltGateway  Get the default gateway IPv4 address for a host’s configured IPv4 address.
NetIPv4_GetAddrSubnetMask  Get the IPv4 address subnet mask for a host’s configured IPv4 address.
NetIPv4_IsAddrHostValidate an IPv4 address as one the host’s IPv4 address(es).
NetIPv4_IsAddrHostCfgd()Validate an IPv4 address as one the host’s configured IPv4 address(es).
NetIPv4_IsAddrsHostCfgdOnIF()Check if any IPv4 address(es) are configured on an interface.
IPv6
NetIPv6_GetAddrHost Get an interface's configured IPv6 host address(es).
NetIPv6_GetAddrSrc Find the best matched source address in the IPv6 configured host addresses for the specified destination address.
NetIPv6_IsAddrHostCfgd()Validate an IPv6 address as a configured IPv6 host address on an enabled interface.
NetIPv6_IsAddrsCfgdOnIF()Validate if any IPv6 host addresses are configured on a specific interface.

Generic IP Address Information Functions

...

Function NameDescription
IPv4
NetIPv4_IsAddrBroadcast()Validate an IPv4 address as the limited broadcast IPv4 address.
NetIPv4_IsAddrClassA()Validate an IPv4 address as a Class-A IPv4 address.
NetIPv4_IsAddrClassB()Validate an IPv4 address as a Class-B IPv4 address.
NetIPv4_IsAddrClassC()Validate an IPv4 address as a Class-C IPv4 address.
NetIPv4_IsAddrLocalHost()Validate an IPv4 address as a Localhost IPv4 address.
NetIPv4_IsAddrLocalLink()Validate an IPv4 address as a link-local IPv4 address.
NetIPv4_IsAddrThisHost()Validate an IPv4 address as the ‘This Host’ initialization IPv4 address.
NetIPv4_IsValidAddrHost()Validate an IPv4 address as a valid IPv4 host address.
NetIPv4_IsValidAddrHostCfgd()Validate an IPv4 address as a valid, configurable IPv4 host address.
NetIPv4_IsValidAddrSubnetMask()Validate an IPv4 address subnet mask.
IPv6
NetIPv6_GetAddrMatchingLen()Compute the number of identical most significant bits of two IPv6 addresses.
NetIPv6_GetAddrScope()Get the scope of a specific IPv6 address.
NetIPv6_IsValidAddrHost()Validate an IPv6 host address. 
NetIPv6_IsAddrLinkLocal()Validate an IPv6 address as a link-local IPv6 address.
NetIPv6_IsAddrSiteLocal()Validate an IPv6 address as a site-local address.
NetIPv6_IsAddrMcast()Validate an IPv6 address as a multicast address.
NetIPv6_IsAddrMcastSolNode()Validate an IPv6 address as a solicited node multicast address.
NetIPv6_IsAddrMcastAllNodes()Validate an IPv6 address as the all nodes multicast address.
NetIPv6_IsAddrMcastAllRouters()Validate an IPv6 address as the all routers multicast address.
NetIPv6_IsAddrMcastRsvd()Validate the IPv6 address as a a reserved multicast IPv6 address.
NetIPv6_IsAddrUnspecified()Validate an IPv6 address as the unspecified IPv6 address.
NetIPv6_IsAddrLoopback()Validate an IPv6 address as the IPv6 loopback address.

IP Address Conversion Utilities

...

Function nameDescription
NetASCII_Str_to_IPConvert a string of an IPv4 or IPv6 address in their respective decimal notation to an IPv4 or IPv6 address.
NetASCII_Str_to_IPv4Convert a string of an IPv4 address in dotted-decimal notation to an IPv4 address in host-order.
NetASCII_Str_to_IPv6Convert a string of an IPv6 address in common-decimal notation to an IPv6 address.
NetASCII_IPv4_to_StrConvert an IPv4 address in host-order into an IPv4 dotted-decimal notation ASCII string.
NetASCII_IPv6_to_StrConvert an IPv6 address into an IPv6 colon-decimal notation ASCII string. 

Hook Functions

IP Address Configuration Hook Functions

...

If you don't bound to an IP address, the µC/TCP-IP stack will take care of setting the source address of packets to send.

 

Refer to section Socket Programming for more information on using network sockets.