Real-Time Network Functions

This section summarizes the Real Time Network (RTN) function set. RTN functions are those functions provided by the RtxTcpIp Protocol Stack and are available for use by an RtxTcpIp NIC driver, an RtxTcpIp filter, or an application. The RTN functions are exported by the stack and may be used by doing the following:

NOTE:  Linking the driver to the appropriate files satisfies the linking requirements for both drivers and filters. There is no need to explicitly link the filter.

For detailed information about a function, click its link in the table below.

Real-Time Network Function Description

RtnAddMultiRoute

First validates if it has received a proper multicast IP address. Then it adds multicast IP 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.

RtnAllocateFrame

Used to obtain a frame from the RtxTcpIp Stack.

RtnAllocRecvBuffers

Called to allocate (fill) the receive packet pool for a driver.

RtnDecodePacket

Used to access various fields in the stack defined packet structure.

RtnDeleteCriticalLock

Frees any associated memory from a CriticalLock.

RtnDeleteMultiRoute

First validates if it has received a proper multicast IP address. It then deletes the multicast IP address from the routing table on the selected device.

RtnDisplayNbrCacheTable

Displays the neighbor cache entry, the neighboring node's IPv6 address, the corresponding link-layer address, and the state of the neighbor cache entry for the network device identifier.

RtnDisplayRoutingTable

Displays all static IPv4 and IPv6 routes from RtxTcpIp stack’s forwarding database.

RtnEnterCriticalLock

Waits on the associated CriticalLock until no other thread is inside a RtnEnterCritcalLock RtnLeaveCriticalLock pairing.

RtnEnumPciCards

Calls the fnCheckPciCard function for every PCI card found within the system (or until fnCheckPciCard returns TRUE), and is used to locate a PCI NIC.

RtnFreeFrame

Used to return a frame to the RtxTcpIp Stack.

RtnFreeRecvBuffers

Called to de-allocate (free) the receive packet pool for a driver.

RtnGetDataLong

Retrieves the value placed at offset index of the network device pointed to by ndp.

RtnGetDeviceFromIpAddress

Converts a binary IP address in network byte order into the network device pointer for the particular device.

RtnGetDeviceName

Returns a pointer to the ASCII character name associated with this driver instance.

RtnGetDevicePtr

Gets the network device pointer associated with ASCII network device name.

RtnGetFilterState

Called when an application wants to know the filter state on a particular interface.

RtnGetIpAddress

Returns the IP address associated with this device instance.

RtnGetMcastCount

Normally used in RtndIoctl to determine the multicast address count.

RtnGetMsPerTick

Returns the tick interval, in milliseconds per tick, that the stack timer is configured to use.

RtnGetPacket

Returns a pointer to an RtxTcpIp Stack packet structure.

RtnGetPrivateProfileString

Used to read the contents of an INI file in Windows standard format.

RtnHtoi

Functions much like the standard C Runtime library atoi function.

RtnInitializeCriticalLock

Initializes a CriticalLock data structure.

RtnInstallStaticRoute

Installs a static IPv4 or IPv6 route in RtxTcpIp stack’s forwarding database.

RtnIOCTLDriver

Called when the filter requires that the driver configure certain NIC modes or characteristics.  

RtnIsDeviceOnline

Used to get the online status of a network device for link status monitoring.

RtnIsStackOnline

Gets the online status of the RT-TCP/IP stack for link status monitoring.

RtnLeaveCriticalLock

Exits a CriticalLock section.

RtnProcessRecvQueue

Processes all the packets on the receive queue for the indicated network device.

RtnQueueRecvFrame

Places a frame on the receive queue for the indicated network device.

RtnQueueRecvPacket

Places a packet on the receive queue for the indicated network device.

RtnRemoveStaticRoute

Removes a static IPv4 or IPv6 route from RtTcpIP stack’s forwarding database.

RtnSetDataLong

Sets the value at offset index of the network device pointed to by ndp.

RtnSetDefaultGateway

Sets the gateway address (in the stack) for an instance of the driver.

RtnSetFilterState

Called when an application wants to set the filter state on a particular interface.

RtnSetLinkAddress

Sets the hardware address (in the stack) for an instance of the driver.

RtnTransmitDone

Notifies the RtxTcpIp Stack that the most recent packet handed to RtndTransmit should be returned to the stack buffer pool for reuse.

RtnTransmitFrame

Called when the filter wants to transmit a frame (pointed to by the parameter mp).

IntervalZero.com | Support | Give Feedback