This section contains documentation on the TCP/IP functions and structures used by the TCP/IP Stack.
These TCP/IP Stack functions are provided by the TCP/IP Stack and can be used by an RTDLL TCP/IP filter or eRTOS application. To use these functions, link with the Stack import library (RtTcpipApi.lib) and include the RttcpipApi.h header file in your project.
TCP/IP API Structures
|
Structure |
Description |
|---|---|
|
This structure defines the interface address format used for IPV4 and IPv6 addresses. |
TCP/IP API Functions
Note: TCP/IP functions are not deterministic.
Note: TCP/IP functions require the TCP/IP Stack to be running.
|
Function |
Description |
|---|---|
|
This function adds an IPv4 address to a network interface. |
|
|
This function adds multicast IPv4 address to the routing table on the selected device. After allocating a new entry in the IGMP table, it then sends the IGMP report of the new entry. |
|
|
This function deletes the requested IP address of a network interface. |
|
|
This function deletes the multicast IPv4 address from the routing table on the selected device. |
|
|
This function is used by a filter driver or an application to allocate a block of memory to store an Ethernet frame. |
|
|
This function frees memory allocated by RtnFrameAllocate. |
|
|
This function is used by a filter driver or an application to transmit an Ethernet frame for the device whose source MAC address is in the frame. |
|
|
This function is used by a filter driver or an application to transmit an Ethernet frame for a device. |
|
|
This function gets the IPv4 address of the default gateway associated with an interface. |
|
|
This function converts a binary IP address in network byte order into the network device pointer for the device. |
|
|
This function returns a pointer to the ASCII character name associated with this network device. |
|
|
This function gets the network device pointer associated with ASCII network device name. |
|
|
This function retrieves a list of IPv4 and IPv6 addresses. |
|
|
This function installs a static IPv4 or IPv6 route in TCP/IP stack’s forwarding database. |
|
|
This function is used to get the online status of a network device for link status monitoring. |
|
|
This function retrieves the heap usage information for the TCP/IP stack. |
|
|
This function removes a static IPv4 or IPv6 route from TCP/IP stack’s forwarding database. |
|
|
This function sets the IPv4 address of the default gateway associated with an interface. |
|
|
This function updates one of the IP addresses of a network interface. |
