SDK Code Changes from RTX64 4.x to wRTOS 1.x
This topic outlines the APIs included in RTX64 4.x SDKs that were enhanced, underwent breaking changes, or were removed in wRTOS 1.x SDKs.
In this
New APIs
This section lists the new APIs in wRTOS 1.x SDKs that are not available in RTX64 4.x SDKs.
New Real-Time APIs
New Real-Time (RTAPI) APIs
- Added RTAPI function RtGetDefaultIdealProcessorNumber, which returns the default ideal processor number that will be assigned to any RTSS process that is not assigned a specific process affinity mask or ideal processor. (1749)
- Added RTAPI function RtIsPerformanceCore, which queries whether the specified core is a performance core. (9317)
- Added RTAPI function RtIsComponentInstalled, which returns the install status and specific version information of the specified product component. (4424)
- Added structure RT_COMPONENT_INFO, which holds the version and readability information of installable components used by functions RtIsComponentInstalled and RtfwIsComponentInstalled. (4424)
- Added RTAPI function RtGetLicenseStatus, which returns whether the specified version of a product code is installed and has a valid license. (914, 8922)
- Added enumerators to enumeration RT_FEATURE_LICENSE_STATUS status in structure RT_LICENSE_INFO to support time-limited licenses. (13627):
- RT_FEATURE_STATUS_RETAIL_VALID indicates the license is a valid retail license (with or without an expiration date).
- RT_FEATURE_STATUS_RETAIL_EXPIRED indicates the license is an expired retail license.
- RT_FEATURE_STATUS_EVAL_VALID indicates the license is a valid evaluation license.
- RT_FEATURE_STATUS_RETAIL_INVALID_HOST_ID indicates the license is a dongle-based retail license for which the host ID is not present on the system.
- Added field ProcessFlags to structure RTPROCESS_INFORMATION. This new field is bit-mask flag value that contains information about a running process. (10048)
- Added new error codes that can be returned by function RtMonitorChangeState (1530):
- RT_ERROR_MONITORING_ENABLED An operation attempted to enable monitoring, but monitoring was already enabled.
- RT_ERROR_MONITORING_DISABLED Monitoring was disabled when an operation was attempted that required it to be enabled.
- RT_ERROR_MONITORING_STARTED Monitoring was started when an operation was attempted that required it to be stopped.
- RT_ERROR_MONITORING_STOPPED Monitoring was stopped when an operation was attempted that required it to be started.
- RT_ERROR_MONITORING_PAUSED Monitoring was paused when an operation was attempted that required it to be running.
New E-CAT (RTECAT) APIs
- Added new functions and data types for E-CAT (RTECAT) APIs.
- Added new functions for E-CAT component (9064):
- Function RtecatGetComponentStatus gets the E-CAT component status.
- Function RtecatGetInstanceStatus gets an E-CAT MainDevice instance status.
- Function RtecatIsComponentLicensed checks if the E-CAT component license is available on the system.
- Function RtecatStartComponent starts all configured E-CAT MainDevice instances.
- Function RtecatStartInstance starts an E-CAT MainDevice instance.
- Function RtecatStopComponent stops all running E-CAT MainDevice instances.
- Function RtecatStopInstance stops a running E-CAT MainDevice instance.
New Debug Message (RTDBG) APIs
- Added new functions and data types for sending messages to Message Viewer (393):
- Function RtdbgCloseBasicChannel closes the Basic message channel for the current process.
- Function RtdbgCloseChannel closes a Standard or Trace message channel.
- Function RtdbgCreateStandardChannel creates a Standard message channel. This channel is identified by the combination of VendorId, ProductCode, and ChannelId. If a channel with the same combination already exists, it will be opened.
- Function RtdbgCreateTraceChannel creates a Trace message channel. This channel is identified by the combination of VendorId, ProductCode, and ChannelId. If a channel with the same combination already exists, it will be opened.
- Function RtdbgGetBasicCategoryName gets the display name of a message category.
- Function RtdbgGetBasicMessage gets the first Basic message in the queue.
- Function RtdbgGetCategoryFilter reads the current category filter value. This value is a bitmap indicating which categories are enabled.
- Function RtdbgGetIndexFilter reads the current index filter value for a trace source, which is an array containing a set of four short values indicating which indexes are enabled for this source. If the first short value is set to -1, all indexes are enabled. If the value is set to RTDBG_FILTER_DISABLED, the filter is disabled and all indexes are allowed.
- Function RtdbgGetMessage gets the first Standard or Trace message in the queue.
- Function RtdbgGetSeverityFilter reads the current severity filter value. This value is a bitmap indicating which severity levels are enabled.
- Function RtdbgGetSourceFilter reads the current source filter value. This value is a bitmap indicating which sources are enabled in the channel.
- Function RtdbgGetTypeFilter reads the current type filter value. This value is a bitmap indicating which types are enabled in the channel.
- Function RtdbgOpenBasicChannel opens the Basic message channel for the current process.
- Function RtdbgSendBasicMessage sends a Basic message.
- Function RtdbgSendBasicMessageIsr sends a Basic message from an Interrupt Service Routine (ISR).
- Function RtdbgSendMessage sends a Standard or Trace message.
- Function RtdbgSendMessageIsr sends a Standard or Trace message from an Interrupt Service Routine (ISR).
- Function RtdbgSetBasicCategoryName sets the display name for a message category.
- Function RtdbgSetCategoryFilter writes the category filter value. This value is a bitmap indicating which categories are enabled.
- Function RtdbgSetIndexFilter writes the index filter value for a trace source. A set of four short values indicating which indexes are enabled for this source. To enable all indexes, set the first short value to -1. To enable all indexes and disable the filter, set the value to RTDBG_FILTER_DISABLED.
- Function RtdbgSetSeverityFilter writes the severity filter value. This value is a bitmap indicating which severity levels are enabled.
- Function RtdbgSetSourceFilter writes the source filter value. This value is a bitmap indicating which sources are enabled in the channel.
- Function RtdbgSetTypeFilter writes the type filter value. This value is a bitmap indicating which types are enabled in the channel.
- Function RtdbgSynchronizeIsrCounter resets the offset used to timestamp Interrupt Service Routine (ISR) messages.
- Data type RTDBG_DATATYPE identifies the type of a value.
- Data type RTDBG_PRINTFORMAT identifies the format used to print a value.
- Data type RTDBG_SEVERITY identifies severity of a Basic message.
- Data type RTDBG_BASIC_MESSAGE_HEADER specifies the header of a Basic message.
- Data type RTDBG_CHANNEL represents a handle to a channel.
- Data type RTDBG_EXTENDED_MESSAGE_HEADER specifies the header of a Standard or Trace message.
New NL2 (RTNL2) APIs
- Added new functions and data types for mapping the UDP ports to receive queues (3173):
- Data type RTNL2_UDP_PORT_DISPATCH_RULE specifies a UDP Port Dispatch rule.
- Function Rtnl2AddUdpPortDispatchRule adds a rule to dispatch incoming packets to a given Physical Receive Queue based on the value of their UDP Destination Port.
- Function Rtnl2DeleteUdpPortDispatchRule deletes a dispatch rule previously set up by Rtnl2AddUdpPortDispatchRule.
- Function Rtnl2GetUdpPortDispatchRules gets the list of UDP Port dispatch rules currently set up in the interface.
- Added new functions and data types to support the Credit-Based Shaper functionality (12807)
- Structure RTNL2_CBS_PARAMS describes Credit-Based Sharper parameters.
- Function Rtnl2SetPhysicalTxQueueCbsParams sets the Credit-Based Shaper parameters on a given Physical Transmit Queue.
- Added new functions and data types for mapping PCP (Priority Code Point) values to receive queues (3174):
- Function Rtnl2AddPcpDispatchRule adds a rule to dispatch incoming packets to a given Physical Receive Queue based on the value of their PCP (Priority Code Point) field in the VLAN Tag.
- Function Rtnl2DeletePcpDispatchRule deletes a dispatch rule previously set up by Rtnl2AddPcpDispatchRule.
- Function Rtnl2GetPcpDispatchRules gets the list of PCP dispatch rules currently set up in the interface.
- Structure RTNL2_VLAN_TAG represents the content an IEEE 802.1Q VLAN Tag.
- Structure RTNL2_PCP_DISPATCH_RULE specifies a PCP (Priority Code Point) Dispatch rule.
- Added new functions for controlling the NL2 component (922):
- Function Rtnl2GetComponentStatus returns the status of the Network Link Layer (NL2) component.
- Function Rtnl2IsComponentLicensed returns the license status of the Network Link Layer (NL2) component.
- Function Rtnl2StartComponent starts the Network Link Layer (NL2) component.
- Function Rtnl2StopComponent stops the Network Link Layer (NL2) component.
- Added new functions and data types for configuring interrupt moderation on a given message ID (11586):
- Function Rtnl2GetMsixMessageConfig retrieves the configuration of an MSI-X message.
- Function Rtnl2SetInterruptModeration sets the interval value for interrupt moderation.
- Structure RTNL2_INTERFACE_CONFIG specifies the configuration of an interface.
- Structure RTNL2_INTERFACE_FEATURES specifies the hardware features supported by an interface.
- Data type RTNL2_HINTERFACE represents a handle to an interface.
- Structure RTNL2_MSIX_MESSAGE_CONFIG is used by the function Rtnl2GetMsixMessageConfig to specify the configuration of an MSI-X message.
- Added new functions and data types for creating a logical transmit queue (12552):
- Function Rtnl2CreateLogicalTxQueue creates a Logical Transmit Queue object above the hardware queue specified by the handle of the owning interface and the index of the Transmit Queue within that interface.
- Function Rtnl2DestroyLogicalTxQueue destroys a Logical Transmit Queue object created by Rtnl2CreateLogicalTxQueue.
- Data type RTNL2_HLOGICAL_TX_QUEUE represents a handle to a Logical Transmit Queue.
- Added these new functions and data types for sending frames over a logical transmit queue (12557):
- Function Rtnl2TransmitOverLogicalTxQueue transmits one frame through a specified Logical Transmit Queue.
- Structure RTNL2_TRANSMIT_DESC is used by function Rtnl2TransmitOverLogicalTxQueue to specify the frame to transmit over a Logical Transmit Queue.
- Added new functions and data types for configuring Logical Receive filters (12572):
- Function Rtnl2StartLogicalRxQueue starts a Logical Receive Queue.
- Function Rtnl2StopLogicalRxQueue stops a Logical Receive Queue.
- Function Rtnl2SetLogicalRxQueueEtherTypeFilter configures the Logical Receive Queue EtherType filter of a Logical Receive Queue.
- Function Rtnl2SetLogicalRxQueueMode enables or disables a setting of the interface mode.
- Function Rtnl2GetLogicalRxQueueMode gets the current setting value of the interface mode.
- Added new functions and data types for receiving frames from a Logical Receive Queue (12567):
- Function Rtnl2ReceiveFromLogicalRxQueue receives one frame from a specified Logical Receive Queue.
- Structure RTNL2_RECEIVE_DESC is used by the function RtNalReceiveFromLogicalRxQueue to describe a receive operation over a Logical Receive Queue.
- Added new functions and data types for creating a Logical Receive Queue (12562):
- Function Rtnl2CreateLogicalRxQueue creates a Logical Receive Queue object on a Physical Receive Queue specified by the handle of the owning interface and the index of the Physical Receive Queue within that interface.
- Function Rtnl2DestroyLogicalRxQueue destroys a Logical Receive Queue object created by Rtnl2CreateLogicalRxQueue.
- Data type RTNL2_HLOGICAL_RX_QUEUE represents a handle to a Logical Receive Queue.
- Added new functions and data types for configuring the hardware timestamp (11605):
- Function Rtnl2EnableLogicalRxQueueTimestamping enables the Ingress Timestamp reporting for the frames received through a given Logical Receive Queue.
- Function Rtnl2EnablePhysicalRxQueueTimestamping enables the Ingress Timestamp reporting for the frames received through a given Physical Receive Queue.
- Data type RTNL2_TIMESTAMP specifies a PTP timestamp, hardware clock time, or time offset.
- Added new functions for configuring Egress Timestamps (299):
- Function Rtnl2EnableLogicalTxQueueTimestamping enables the Egress Timestamp logic on a given Logical Transmit Queue and creates an event to monitor Egress Timestamps.
- Function Rtnl2EnablePhysicalTxQueueTimestamping enables the Egress Timestamp logic on a Physical Transmit Queue and creates an event to monitor Egress Timestamps.
- Function Rtnl2GetLogicalTxQueueTimestamp gets the value of the last Egress Timestamp for the Logical Transmit Queue.
- Function Rtnl2GetPhysicalTxQueueTimestamp gets the value of the last Egress Timestamp for the Physical Transmit Queue.
- Added new functions and data types for getting a handle to a network interface (11577):
- Function Rtnl2EnumInterface returns the name of an interface specified by its index.
- Function Rtnl2OpenInterface opens the interface object specified by its name.
- Function Rtnl2CloseInterface closes a handle to an interface object.
- Function Rtnl2GetInterfaceConfig gets the configuration of an interface.
- Function Rtnl2GetPhysicalTxQueueConfig gets the configuration of a Physical Transmit Queue.
- Function Rtnl2GetPhysicalRxQueueConfig gets the configuration of a Physical Receive Queue.
- Function Rtnl2GetInterfaceFeatures gets the hardware features supported by an interface.
- Function Rtnl2GetMacAddress gets the MAC address of an interface.
- Data type RTNL2_PHYSICAL_TX_QUEUE_CONFIG specifies the current configuration of a Physical Transmit Queue.
- Data type RTNL2_PHYSICAL_RX_QUEUE_CONFIG specifies the current configuration of a Physical Receive Queue.
- Added new functions and data types for allocating and releasing NL2 buffers (11582):
- Function Rtnl2GetPhysicalTxQueueBuffers gets one or more NL2 buffers to be used with a specified physical transmit queue.
- Function Rtnl2ReturnPhysicalTxQueueBuffers returns one or more NL2 Buffers that were received for the specified physical transmit queue.
- Data type RTNL2_BUFFER_HEADER specifies a buffer allocated by Rtnl2GetPhysicalTxQueueBuffers.
- Added new functions and data types for mapping the EtherType to receive queues (11585):
- Function Rtnl2AddEtherTypeDispatchRule adds a rule to dispatch incoming packets to a given Physical Receive Queue based on the value of their EtherType.
- Function Rtnl2DeleteEtherTypeDispatchRule deletes a dispatch rule previously set up by Rtnl2AddEtherTypeDispatchRule.
- Function Rtnl2GetEtherTypeDispatchRules gets the list of EtherType dispatch rules currently set up in the interface.
- Data type RTNL2_ETHER_TYPE_DISPATCH_RULE specifies an EtherType dispatch rule.
- Added new functions and data types for monitoring and getting the link status (11578):
- Function Rtnl2CreateLinkStatusChangeEvent creates an event to be signaled by the NL2 process whenever the link status for the specified interface changes.
- Function Rtnl2DestroyLinkStatusChangeEvent destroys a LinkStatusChange event previously created by Rtnl2CreateLinkStatusChangeEvent.
- Function Rtnl2GetLinkStatus gets the current link status of an interface.
- Data type RTNL2_LINK_STATUS specifies the status of the link.
- Added new functions and data types for sending frames over an acquired transmit hardware queue (681):
- Function Rtnl2AcquirePhysicalTxQueue acquires a Physical Transmit Queue object specified by the handle of the owning interface and the index of the Physical Transmit Queue within that interface.
- Function Rtnl2SubmitToPhysicalTxQueue submits NL2 buffers for transmission through a given Physical Transmit Queue.
- Function Rtnl2CreatePhysicalTxQueueEvent enables the hardware interrupt for a given Physical Transmit Queue and creates an event for the specified Physical Transmit Queue. This event is signaled by the NL2 each time the NIC triggers the hardware interrupt associated with that Physical Transmit Queue.
- Function Rtnl2DestroyPhysicalTxQueueEvent destroys a Transmit event previously created by Rtnl2CreatePhysicalTxQueueEvent, and disables the hardware interrupt associated with the Physical Transmit Queue.
- Function Rtnl2ExtractFromPhysicalTxQueue checks the DMA ring of the specified Physical Transmit Queue, and extracts buffers from the FIFO of consumed buffers.
- Rtnl2ReleasePhysicalTxQueue releases a Physical Transmit Queue object previously acquired by Rtnl2AcquirePhysicalTxQueue.
- Data type RTNL2_HPHYSICAL_TX_QUEUE represents a handle to a Physical Transmit Queue.
- Added new functions, data types and enumerations for receiving frames from an acquired receive hardware queue (829, 850):
- Function Rtnl2AcquirePhysicalRxQueue acquires a Physical Receive Queue object specified by the handle of the owning interface and the index of the Physical Receive Queue within that interface.
- Function Rtnl2SetPhysicalRxQueueMode enables or disables an interface mode setting.
- Function Rtnl2GetPhysicalRxQueueMode gets the current setting value of the interface mode.
- Function Rtnl2SubmitToPhysicalRxQueue submits NL2 buffers for reception through a given Physical Receive Queue.
- Function Rtnl2CreatePhysicalRxQueueEvent enables the hardware interrupt for a given Physical Receive Queue and creates an event for the specified Physical Receive Queue. This event is signaled by the NL2 each time the NIC triggers the hardware interrupt associated with that Physical Receive Queue.
- Function Rtnl2DestroyPhysicalRxQueueEvent destroys a Receive event previously created by Rtnl2CreatePhysicalRxQueueEvent, and disables the hardware interrupt associated with the Physical Receive Queue.
- Function Rtnl2ExtractFromPhysicalRxQueue checks the DMA ring of the specified Physical Receive Queue, and extracts buffers from the FIFO of filled buffers.
- Function Rtnl2ReleasePhysicalRxQueue releases a Physical Receive Queue object previously acquired by Rtnl2AcquirePhysicalRxQueue.
- Data type RTNL2_HPHYSICAL_RX_QUEUE represents a handle to a Physical Receive Queue.
- Enumeration RTNL2_RX_MODE_SETTING specifies a given setting of the interface mode.
- Added new functions for configuring multicast filters (714):
- Function Rtnl2SetLogicalRxQueueMulticastFilter configures the per-queue list of allowed Multicast Addresses for a given Logical Receive Queue.
- Function Rtnl2SetPhysicalRxQueueMulticastFilter configures the per-queue list of allowed Multicast Addresses for a given Physical Receive Queue.
- Added new functions and data types to support cross-timestamping (PTM) (9427):
- Data type RTNL2_HCLOCK represents a handle to a clock.
- Structure RTNL2_READ_CLOCK_RESULT describes the result of the operations made by the Rtnl2ReadClock function.
- Function Rtnl2OpenClock opens a clock object specified by the handle of the owning interface and the index of the clock within that interface.
- Function Rtnl2ReadClock reads the NIC clock time and the CPU time simultaneously (cross-timestamp) and returns all timestamps.
- Function Rtnl2AdjustClockTime adjusts the time of a clock object by applying an offset to the current counter value.
- Function Rtnl2SetClockRate sets the rate of a clock object.
- Function Rtnl2GetClockRate gets the rate of a clock object.
- Function Rtnl2CloseClock closes a clock object opened by Rtnl2OpenClock.
- Added function Rtnl2ControlDeviceSpecialFunction, which controls a special function of a device.
New Network Relay (RTRLY) APIs
- Added new functions for controlling the Network Relay component (10581):
- RtrlyIsComponentLicensed returns whether the Network Relay component has a valid license of the same major version as the currently installed wRTOS Runtime.
- RtrlyStartComponent starts the Network Relay component.
- RtrlyStopComponent stops the Network Relay component.
- RtrlyGetComponentStatus returns the status of the Network Relay component.
New TCP/IP (RTTCPIP) APIs
- Added new functions for controlling the TCP/IP Stack component (933):
- RttcpipGetComponentStatus returns the status of the TCP/IP Stack component.
- RttcpipIsComponentLicensed returns the license status of the TCP/IP Stack component.
- RttcpipStartComponent starts the TCP/IP Stack component.
- RttcpipStopComponent stops the TCP/IP Stack component.
- Added new functions for configuring the IP address of a network interface (333):
- RttcpipAddInterfaceAddress adds an IPv4 address to a network interface.
- RttcpipDeleteInterfaceAddress deletes the requested IP address of a network interface.
- RttcpipGetDefaultGateway gets the IPv4 address of the default gateway associated with an interface.
- RttcpipGetInterfaceAddresses retrieves a list of IPv4 and IPv6 addresses.
- RttcpipSetDefaultGateway sets the IPv4 address of the default gateway associated with an interface.
- RttcpipUpdateInterfaceAddress updates one of the IP addresses of a network interface.
- RTTCPIPINTERFACEADDRESS defines the interface address format used for IPV4 and IPv6 addresses.
New TCP/IP Filter Driver (RTTCPIPFLT) APIs:
- Function RttcpipfltConfigure is called once for each NIC associated with the Filter Driver at TCP/IP Stack startup.
- Function RttcpipfltReceive is called every time the TCP/IP Stack receives an Ethernet frame from the network.
- Function RttcpipfltReceiveEx is called every time the TCP/IP Stack receives an Ethernet frame from the network. This function includes an additional parameter compared to RttcpipfltReceive which points to the network device that received the frame.
- Function RttcpipfltTransmit is called every time the TCP/IP Stack is about to send an Ethernet frame over the network.
- Function RttcpipfltTransmitEx is called every time the TCP/IP Stack is about to send an Ethernet frame over the network. This function includes an additional parameter compared to RttcpipfltTransmit, which is a pointer to the network device that should send the frame.
- Structure RTTCPIPFLT_ETHERNET_HEADER represents 14 bytes of an Ethernet frame header.
New NIC Driver (RTND) APIs
- Added Callback APIs that are meant to be called from NL2 drivers:
- Structure RTND_CALLBACKS contains function pointers to Network Link Layer (NL2) callbacks.
- Function CreateRxBuffers is meant to be called by a driver to allocate a new set of NL2 Receive Buffers.
- Function CreateTxBuffers is meant to be called by a driver to allocate a new set of NL2 Transmit Buffers.
- Function DestroyRxBuffers is meant to be called by a driver to destroy one or several NL2 Receive Buffers that were previously created by CreateRxBuffers.
- Function DestroyTxBuffers is meant to be called by a driver to destroy one or more NL2 Transmit Buffers that were previously created by CreateTxBuffers.
- Function GetVerbose returns a verbose Boolean received by the Network Link Layer (NL2) process from the Windows registry at startup.
- Function NotifyEgressTimestamp is meant to be called by the IST of the driver when it detects that a new Egress Timestamp is available for one of the Transmit Queues of one of its managed interfaces.
- Function NotifyLinkStatusChange is meant to be called by the IST of the driver when it detects a link status change on one of its managed interfaces.
- Function NotifyRxInterrupt is meant to be called by the IST of the driver when a buffer is filled by a Receive Queue.
- Function NotifyTxInterrupt is meant to be called by the IST of the driver when a buffer is consumed by a Transmit Queue.
- Added data types of interface capabilities reported by the driver to the NL2. These data types describe the supported options and parameter ranges that the NL2 can set for an interface before starting it. (5066)
- Enumeration RTND_CAPABILITY_ID identifies a given interface capability.
- Structure RTND_CAPABILITY_CLOCK describes the interface's clock-related capability.
- Structure RTND_CAPABILITY_INTERRUPT describes the interface's interrupt capability.
- Structure RTND_CAPABILITY_JUMBO describes the interface's jumbo capability.
- Structure RTND_CAPABILITY_LINK describes the interface's link-related capability.
- Structure RTND_CAPABILITY_RX describes the interface's receive capability.
- Structure RTND_CAPABILITY_RX_RING describes a Receive Queue's DMA ring capability.
- Structure RTND_CAPABILITY_TSN describes the interface's TSN-related capability.
- Structure RTND_CAPABILITY_TX describes the interface's transmit capability.
- Structure RTND_CAPABILITY_TX_RING describes a Transmit Queue's DMA ring capability.
- Added structure RTND_BUFFER_HEADER, which describes both Transmit and Receive Buffers. This structure is only visible to the driver, not the application. (5087)
- Added structure RTND_BUFFER_OBJECT, which is an opaque data type that represents the buffer object descriptor used by the NL2 internally. (5087)
- Added data type RTND_INTERFACE_OBJECT, which is used in opaque pointers to identify Interface objects from the drivers. (5060)
- Added structure RTND_MULTICAST_ENTRY, which describes an entry of a linked list of Multicast Addresses. (5084)
- Added structure RTND_TIMESTAMP, which describes a PTP timestamp, hardware clock time, or time offset. (5081)
- Added structure RTND_DISPATCHER_ETHER_TYPE_ENTRY, which describes an entry of the EtherType Hardware Dispatcher. (5078)
- Added structure RTND_DISPATCHER_UDP_PORT_ENTRY, which describes an entry of the UDP Port Hardware Dispatcher. (3173)
- Added structure RTND_LINK_STATUS, which describes the link status. (5075)
- Added data types of interface settings that the NL2 can configure before starting the interface. (5069)
- Enumeration RTND_SETTING_ID identifies a given interface setting for the RtndSetInterface function.
- Structure RTND_SETTING_CLOCK describes the interface's clock setting.
- Structure RTND_SETTING_INTERRUPT describes the interface's interrupt setting.
- Structure RTND_SETTING_JUMBO describes the interface's jumbo setting.
- Structure RTND_SETTING_LINK describes the interface's link setting.
- Structure RTND_SETTING_NON_QUEUE_MSIX_MAPPING describes the interface's non-queue interrupt mapping setting.
- Structure RTND_SETTING_RX_QUEUE_MSIX_MAPPING describes the Receive Queue's interrupt mapping setting.
- Structure RTND_SETTING_RX_QUEUE_TIMESTAMPING describes the Receive Queue's timestamping setting.
- Structure RTND_SETTING_RX_RING describes the Receive Queue's DMA ring setting.
- Structure RTND_SETTING_TX_QUEUE_MSIX_MAPPING describes the Transmit Queue's interrupt mapping setting.
- Structure RTND_SETTING_TX_QUEUE_SCHEDULING describes the Transmit Queue's scheduling algorithm.
- Structure RTND_SETTING_TX_QUEUE_TIMESTAMPING describes the Transmit Queue's timestamping setting.
- Structure RTND_SETTING_TX_RING describes the Transmit Queue's DMA ring setting.
- Added data types for features that are reported by the driver to the NL2. These features describe the supported options and parameter ranges that the NL2 can use while the interface is started. (5072)
- Enumeration RTND_FEATURE_ID identifies a given interface feature.
- Structure RTND_FEATURE_BUFFERS describes the buffers feature supported by an interface.
- Structure RTND_FEATURE_DISPATCH_RULES describes the hardware dispatch rules interface feature.
- Structure RTND_FEATURE_INTERFACE_MODES describes the dynamic modes supported by an interface.
- Structure RTND_FEATURE_INTERRUPT describes the interrupt feature supported by an interface.
- Added structure RTND_DRIVER_INFO, which contains global driver information not specific to a particular interface. (4851)
- Added function RtndShutdownInterface, which shuts down an interface. After the function returns, the NIC will no longer generate a hardware interrupt. (5146)
- Added new functions for allocating and freeing transmit and receive data buffers (2396):
- RtndAllocateRxFrameDataBuffers allocates a set of receive frame data buffers.
- RtndAllocateTxFrameDataBuffers allocates a set of transmit frame data buffers.
- RtndFreeRxFrameDataBuffers frees a set of receive frame data buffers previously allocated by RtndAllocateRxFrameDataBuffers.
- RtndFreeTxFrameDataBuffers frees a set of transmit frame data buffers previously allocated by RtndAllocateTxFrameDataBuffers.
- Added new functions and data types to support the NL2 driver interface (17696):
- Function RtndInitDriver provides drivers with pointers to the NL2 callback functions.
- Function RtndManageInterface manages an interface on the PCI Bus.
- Function RtndQueryInterfaceCapability gets a given capability of an interface.
- Function RtndSetInterface writes a given setting to the interface.
- Function RtndStartInterface starts an interface.
- Function RtndQueryMacAddress gets the MAC address of an interface.
- Function RtndQueryInterfaceFeature gets a given feature of an interface.
- Function RtndStopInterface stops an interface.
- Function RtndUnmanageInterface removes all associations made for a given interface.
- Function RtndQueryLinkStatus gets the Link Status of an interface.
- Function RtndSetPromiscuousMode requests the interface to enable or disable promiscuous mode.
- Function RtndSetPassBadFramesMode requests the interface to enable or disable the Pass Bad Frames mode.
- Function RtndSetInterruptModeration requests the interface to change the value of the interval, in nanoseconds, for interrupt moderation. If the interrupt type is MSI-X, the NL2 will supply the message ID of the MSI-X message to throttle. Otherwise, the NL2 will set the MessageId parameter to zero (0).
- Function RtndSetDispatcherEtherTypeEntry updates an entry in the EtherType Hardware Dispatcher table.
- Function RtndGetDispatcherEtherTypeEntry gets an entry in the EtherType Hardware Dispatcher table.
- Function RtndSetDispatcherUdpPortEntry updates an entry in the UDP Port Hardware Dispatcher. (3173)
- Function RtndGetDispatcherUdpPortEntry gets an entry in the UDP Port Hardware Dispatcher table. (3173)
- Function RtndGetDispatcherPcpEntry gets an entry in the PCP Hardware Dispatcher table.
- Function RtndSetDispatcherPcpEntry updates an entry in the PCP Hardware Dispatcher table.
- Structure RTND_CAPABILITY_VLAN describes an interface’s VLAN capability.
- Structure RTND_VLAN_TAG represents the content of an IEEE 802.1Q VLAN Tag.
- Structure RTND_DISPATCHER_PCP_ENTRY describes an entry of the PCP (Priority Code Point) Hardware Dispatcher.
- Function RtndSetMulticastFilter updates the hardware Multicast Hash Filter of an interface.
- Function RtndEnableTxInterruptSource enables or disables the transmit interrupt for a specific Transmit Queue.
- Function RtndAttachTxQueue attaches the specified Transmit Queue to the current application process.
- Function RtndApplyTxBuffers transmits all buffers inserted in the Transmit Queue with RtndSubmitTxBuffer.
- Function RtndExtractLastTxTimestamp determines whether the Egress Timestamp register associated with a given Transmit Queue is valid and, if it is, returns the Egress Timestamp value.
- Function RtndSubmitTxBuffer inserts a buffer to the specified Transmit Queue.
- Function RtndExtractTxBuffer extracts a consumed buffer from the specified Transmit Queue.
- Function RtndDetachTxQueue detaches the specified Transmit Queue to the current application process.
- Function RtndGetTxBuffers gets multiple buffers from the driver's pool of available transmit buffers.
- Function RtndReturnTxBuffers returns multiple buffers to the driver's pool of available transmit buffers.
- Function RtndStartRxQueue starts the specified Receive Queue.
- Function RtndStartTxQueue starts the specified Transmit Queue.
- Function RtndEnableRxInterruptSource enables or disables the receive interrupt for a specific Receive Queue.
- Function RtndStopRxQueue stops the specified Receive Queue.
- Function RtndStopTxQueue stops the specified Transmit Queue.
- Function RtndAttachRxQueue attaches the specified Receive Queue to the current application process.
- Function RtndApplyRxBuffers fetches all buffers inserted in the Receive Queue with RtndSubmitRxBuffer.
- Function RtndSubmitRxBuffer inserts a buffer to the specified Receive Queue.
- Function RtndExtractRxBuffer extracts a filled buffer from the specified Receive Queue.
- Function RtndDetachRxQueue detaches the specified Receive Queue to the current application process.
- Added functions and data types to support cross-timestamping (PTM) (9427):
- Structure RTND_FEATURE_CLOCK describes the clock feature of an interface.
- Structure RTND_READ_CLOCK_RESULT describes the result of the operations made by the RtndReadClock function.
- Function RtndReadClock reads a NIC clock time and CPU time simultaneously (cross-timestamp) and returns all timestamps.
- Function RtndAdjustClockTime adjusts the time of a NIC clock by applying an offset to the current counter value.
- Function RtndSetClockRate sets the rate of a NIC clock.
- Added function RtndControlDeviceSpecialFunction, which controls a special function of a device.
- Added new functions and data types to support the Credit-Based Shaper functionality (12807)
- Structure RTND_CBS_PARAMS describes Credit-Based Shaper parameters.
- Function RtndSetCbsParams sets the Credit-Based Shaper parameters on a given Transmit Queue.
New NL2 Filter Driver (RTNDFLT) APIs
- Added new functions and data types that a Filter Driver must support to be used by the Network Link Layer (NL2) (5348):
- Function RtndfltInitDriver initializes the filter driver and exchanges global information between the filter driver and the Network Link Layer (NL2).
- Function RtndfltEndDriver ends a filter driver.
- Function RtndfltManageRxQueue initializes an instance of the filter driver for the specified Rx Queue.
- Function RtndfltUnmanageRxQueue removes all associations made for a given Rx Queue.
- Function RtndfltReceiveFrames inspects a batch of NL2 Buffers (represented by a linked list of RTND Buffer Headers) corresponding to a burst of received frames on the specified Rx Queue, and determines for each whether it will be dropped or passed to the application.
- Structure RTNDFLT_CALLBACKS contains function pointers to NL2 callbacks.
- Structure RTNDFLT_DRIVER_INFO contains global driver information not specific to an Rx Queue.
New Variable Database (RTVDB) APIs
- Added new functions and data types for user applications to define variables exposed to MaxRT tools and servers (4094):
- Function RtvdbBrowseDatabases gets the list of databases.
- Function RtvdbBrowseDirectory browses a directory.
- Function RtvdbCloseDatabase closes a database.
- Function RtvdbCloseDirectory closes a directory.
- Function RtvdbCloseVariable closes a variable.
- Function RtvdbCreateBufferVariable creates and opens a buffer variable.
- Function RtvdbCreateDatabase creates a database, opens it and its root directory.
- Function RtvdbCreateDirectory creates and opens a sub-directory.
- Function RtvdbCreateVariable creates and opens a variable.
- Function RtvdbDeleteDatabase deletes a database.
- Function RtvdbDeleteDirectory deletes a directory.
- Function RtvdbDeleteVariable deletes a variable.
- Function RtvdbGetDatabaseStatus gets the status of a database.
- Function RtvdbInitialize initializes the variable database library for the current process.
- Function RtvdbOpenDatabase opens a database and its root directory.
- Function RtvdbOpenDirectory opens a sub-directory.
- Function RtvdbOpenVariable opens a variable.
- Function RtvdbRelease closes the variable database library for the current process.
- Function RtvdbRenameDirectory renames a directory.
- Data type RTVDB_DATABASE represents a handle to a database.
- Data type RTVDB_DATABASE_DESCRIPTION describes a database and its state.
- Data type RTVDB_DIRECTORY represents a handle to a directory.
- Data type RTVDB_VARIABLE represents a handle to a variable.
- Data type RTVDB_VARIABLE_CONTROL provides access to a variable.
- Data type RTVDB_VARIABLE_DESCRIPTION describes a variable.
- Data type RTVDB_VARIABLE_DATATYPE identifies the data type of a variable.
New Data Logger APIs
- Added new functions and data types to log variables (4099):
- Function RtvdbGetLogData reads the logged data, automatically wrapping around the end of the data logger buffer. It stops when reaching the current log index. This function also reads data points. Each point has a value for each channel.
- Function RtvdbGetLogStatus gets the current log status.
- Function RtvdbLogBackgroundProcess initializes and releases the data logger.
- Function RtvdbLogCyclicProcess triggers the data-logging engine's cyclic process. The real-time application's cyclic task calls this function to trigger data collection synchronized with its process.
- Function RtvdbStartLog sends a request to start the log.
- Function RtvdbStopLog cancels the current log request.
- Data type RTVDB_CHANNEL provides access to a variable to log.
- Data type RTVDB_LOG_STATUS identifies the status of a log command.
- Data type RTVDB_POINT identifies the value of a data point.
- Data type RTVDB_TRIGGER describes the logging trigger.
- Data type RTVDB_TRIGGER_TYPE identifies the comparison between the current and reference values to trigger the log.
New Winsock APIs
New Winsock APIs
- Added new functions for converting the local index of a network interface to the ANSI name, and vice versa (333):
- if_indextoname converts the local index for a network interface to the ANSI interface name.
- if_nametoindex converts the ANSI interface name for a network interface to a local index for the interface.
New Configure and Control APIs
New Configure and Control APIs
- Added function RtfwUnloadRtApi, which unloads the RTAPI library. (6370)
- Added APIs for configuring E-CAT component instances (9064):
- Structure RTFWECAT_INSTANCE_CONFIGURATION holds the E-CAT MainDevice instance configuration information.
- Function RtfwecatConfigureInstance configures an E-CAT MainDevice instance.
- Function RtfwecatCreateInstance defines a new E-CAT MainDevice instance.
- Function RtfwecatDeleteInstance deletes an E-CAT MainDevice instance.
- Function RtfwecatGetAllInstances gets the configuration of all E-CAT MainDevice instances.
- Function RtfwecatGetInstance gets the current E-CAT MainDevice instance configuration.
- Added functions for setting and retrieving the default ideal processor (1749):
- Function RtfwSetDefaultIdealProcessor sets the default processor where new processes will be executed by default.
- Function RtfwGetDefaultIdealProcessor retrieves the default processor where new processes will be executed by default.
- Added APIs for configuring and querying configuration details for the Network Link Layer (NL2) and its interfaces: (5128, 896)
- Function Rtfwnl2CreateInterface creates a new wRTOS network interface to be used by the Network Link Layer (NL2).
- Function Rtfwnl2DeleteInterface deletes a Network Link Layer (NL2) interface.
- Function Rtfwnl2EnableInterface enables or disables a Network Link Layer (NL2) interface.
- Function Rtfwnl2GetAllInterfaces returns the configurations of all Network Link Layer (NL2) interfaces.
- Function Rtfwnl2GetClientProcessIDs returns the IDs for all Network Link Layer (NL2) client processes.
- Function Rtfwnl2GetConfiguration returns the configuration of the Network Link Layer (NL2).
- Function Rtfwnl2SetConfiguration sets the configuration of the Network Link Layer (NL2).
- Function Rtfwnl2GetInterface returns the configuration of a Network Link Layer (NL2) interface associated with a given name.
- Function Rtfwnl2RenameInterface renames a Network Link Layer (NL2) interface.
- Function Rtfwnl2SetInterface sets the configuration of a Network Link Layer (NL2) interface.
- Function Rtfwnl2GetVerbosity returns whether verbosity is enabled or disabled for the Network Link Layer (NL2).
- Function Rtfwnl2SetVerbosity enables or disables verbosity for the Network Link Layer (NL2).
- Structure RTFW_INTERFACE_INFO contains the name and enabled state of a Network Link Layer (NL2) interface.
- Structure RTFW_NL2_CONFIGURATION contains the configuration of the Network Link Layer (NL2).
- Structure RTFW_NL2_INTERFACE contains the configuration parameters of a Network Link Layer (NL2) interface.
- Structure RTFW_NL2_INTERFACE_MSIXMESSAGE contains the configuration of one MSI-X message for a Network Link Layer (NL2) interface.
- Structure RTFW_NL2_INTERFACE_RXQUEUE contains receive queue information for a Network Link Layer (NL2) interface.
- Structure RTFW_NL2_INTERFACE_TXQUEUE contains transmit queue information for a Network Link Layer (NL2) interface.
- Added functions for getting and setting the global TCP/IP configuration: (5209)
- Function RtfwtcpipGetConfiguration returns the configuration of the TCP/IP Stack.
- Function RtfwtcpipSetConfiguration sets the global configuration of the TCP/IP Stack.
- Added APIs for querying Network Link Layer (NL2) interfaces that have TCP/IP settings (5219, 5128):
- Function RtfwtcpipGetAllInterfaces enumerates all Network Link Layer (NL2) interfaces that have TCP/IP settings.
- Added functions to set and return TCP/IP Stack verbosity: (5214)
- Function RtfwtcpipGetVerbosity returns whether verbosity is enabled or disabled for the TCP/IP Stack.
- Function RtfwtcpipSetVerbosity enables or disables verbosity for the TCP/IP Stack.
- Added APIs for configuring, setting, and querying TCP/IP interface values. (5224)
- Function RtfwtcpipGetInterfaceSettings returns the configuration of a TCP/IP Stack interface associated with a given name.
- Function RtfwtcpipSetInterfaceSettings sets the configuration of a TCP/IP Stack interface.
- Structure RTFW_TCPIP_INTERFACE represents the configuration parameters of a TCP/IP Stack interface.
- Added function RtfwtcpipEnableInterface, which enables or disables TCP/IP functionality for a specified network interface. (8962)
- Added function RtfwIsComponentInstalled, which returns the install status and specific version information of the specified product component. (4424)
- Added function RtfwGetLicenseStatus, which returns whether the specified version of a product code has a valid license. (948, 8922)
- Added functions for controlling and querying the Network Link Layer (NL2) component. (953)
- Rtfwnl2GetComponentStatus returns the status of the Network Link Layer (NL2) component.
- Rtfwnl2IsComponentLicensed returns whether the Network Link Layer (NL2) component has a valid license of the same major version as the currently installed wRTOS Runtime.
- Rtfwnl2StartComponent starts the Network Link Layer (NL2) component.
- Rtfwnl2StopComponent stops the Network Link Layer (NL2) component.
- Added functions for controlling and querying the TCP/IP Stack component. (958)
- RtfwtcpipGetComponentStatus returns the status of the TCP/IP Stack component.
- RtfwtcpipIsComponentLicensed returns whether the TCP/IP Stack component has a valid license of the same major version as the currently installed wRTOS Runtime.
- RtfwtcpipStartComponent starts the TCP/IP Stack component.
- RtfwtcpipStopComponent stops the TCP/IP Stack component.
- Added functions for configuring the Network Relay component:
- RtfwrlyEnableInterface enables or disables Network Relay functionality in a network interface.
- RtfwrlyGetAllInterfaces returns the configurations of all Network Relay interfaces.
- RtfwrlyGetConfiguration returns the Network Relay configuration.
- RtfwrlyGetInterfaceSettings returns a Network Relay interface configuration associated with a given name.
- RtfwrlyGetVerbosity returns whether verbosity is enabled or disabled for the Network Relay component.
- RtfwrlySetConfiguration sets the Network Relay configuration.
- RtfwrlySetInterfaceSettings sets the configuration of a Network Relay interface.
- RtfwrlySetVerbosity enables or disables verbosity for the Network Relay component.
- RTFW_RLY_CONFIGURATION contains the configuration of the Network Relay component. See structure RTFW_RLY_INTERFACE for configuration parameters specific to a Network Relay interface.
- RTFW_RLY_INTERFACE represents the configuration parameters of a Network Relay interface.
New GigE Vision (RTGV) APIs
New GigE Vision (RTGV) APIs
- Added new functions to read/write a value from/to a register on the camera (9232):
- Function RtgvReadRegister reads a value from a register on the camera.
- Function RtgvWriteRegister writes a value to a register on the camera.
New Managed APIs
New Managed APIs
- Added RtfwUnloadRtApi, which unloads the RTAPI library. This is only necessary if you need to detach from the Subsystem after a Subsystem-dependent function is called. (6370)
- Added APIs for getting and setting the default core where a process's main thread will run unless an ideal processor is provided when running the process. (1749)
- Property Subsystem.DefaultIdealProcessor gets or sets the default core that a process's main thread runs on unless an ideal processor is provided when the process runs.
- Method Subsystem.ResetDefaultIdealProcessor resets property DefaultIdealProcessor to its default value (0). After this method is called, the real-time Subsystem must be restarted for the change to take effect.
- Added APIs for controlling and configuring the Network Link Layer (NL2) component. (991, 7302, 7307)
- Namespace IntervalZero.MaxRT.NL2.Control contains types used to control the NL2.
- Class Component encapsulates various control operations for the NL2.
- Method Component.Start starts the NL2.
- Method Component.Stop stops the NL2.
- Method Component.GetStatus queries the status of the NL2.
- Method Component.GetClientProcessIDs gets a list of client process IDs that are using the NL2 component.
- Namespace IntervalZero.MaxRT.NL2.Config contains types used to configure the NL2.
- Class Component encapsulates various configuration operations for the NL2.
- Method Component.IsLicensed returns whether the NL2 component has a valid license of the same major version as the installed wRTOS Runtime.
- Method Component.ResetAll resets the NL2 component to default values.
- Method Component.ResetAutoStart resets the AutoStart property to its default value of false.
- Method Component.ResetExtMSpacePoolMinimumSize resets the ExtMSpacePoolMinimumSize property to its default value of 1024.
- Method Component.ResetMainThreadIdealProcessor resets the MainThreadIdealProcessor property to its default value of 0.
- Method Component.ResetMainThreadPriority resets the MainThreadPriority property to it's default value of 66.
- Method Component.ResetMSpacePoolExpandable resets the MSpacePoolExpandable property to its default value of 1.
- Method Component.ResetMSpacePoolExpandSize resets the MSpacePoolExpandSize property to its default value of 1024.
- Method Component.ResetVerbose resets the Verbose property to its default value of false.
- Property Component.AutoStart gets or sets whether the NL2 component should start automatically.
- Property Component.ExtMSpacePoolMinimumSize gets or sets the minimum size of the external memory space pool for the NL2.
- Property Component.MainThreadIdealProcessor gets or sets the ideal processor for the NL2’s main thread.
- Property Component.MainThreadPriority sets the priority of the NL2’s main thread.
- Property Component.MSpacePoolExpandable gets or sets whether the NL2's memory space pool is expandable.
- Property Component.MSpacePoolExpandSize sets the size the NL2’s memory space pool should expand by.
- Property Component.Verbose gets or sets a Boolean indicating whether verbose logging is enabled.
- Class InterfaceSettings allows users to set the configuration of a network interface for the NL2 component.
- Constructor InterfaceSettings initializes a new instance of the InterfaceSettings class to represent an NL2 interface.
- Method InterfaceSettings.AddMsixMessage adds an MsixMessage object to the NL2 InterfaceSettings object.
- Method InterfaceSettings.AddRxQueue adds an RxQueue object to the NL2 InterfaceSettings object.
- Method InterfaceSettings.AddTxQueue adds a TxQueue object to the NL2 InterfaceSettings object.
- Method InterfaceSettings.CreateInterfaceSettings creates an NL2 interface.
- Method InterfaceSettings.DeleteInterface deletes the NL2 interface.
- Method InterfaceSettings.GetAllInterfaceSettings returns a list of interfaces that are configured on the system for the TCP/IP component.
- Method InterfaceSettings.RemoveMsixMessage removes an MsixMessage object from the NL2 InterfaceSettings object.
- Method InterfaceSettings.RemoveRxQueue removes an RxQueue object from the NL2 InterfaceSettings object.
- Method InterfaceSettings.RemoveTxQueue removes a TxQueue object from the NL2 InterfaceSettings object.
- Property InterfaceSettings.DeviceInstanceID accesses the device Instance ID used by this NL2 interface.
- Property InterfaceSettings.Driver accesses the driver's name for this NL2 interface.
- Property InterfaceSettings.Enabled controls whether the interface is enabled or disabled.
- Property InterfaceSettings.FlowControl accesses the FlowControlType enumeration specifying the flow control type used by this interface.
- Property InterfaceSettings.HardwareTimestampingEnabled controls whether the interface is HardwareTimestampingEnabled.
- Property InterfaceSettings.IngressTimestampingEtherType gets or sets the EtherType if HardwareTimestampingEnabled is true.
- Property InterfaceSettings.IngressTimestampingRule accesses the IngressTimeStampingRuleType enumeration specifying the Ingress Timestamp rule type used by this interface.
- Property InterfaceSettings.IngressTimestampingUDPPort gets or sets the UDP port if HardwareTimestampingEnabled is true.
- Property InterfaceSettings.Interrupt accesses the InterruptType enumeration specifying the interrupt type used by this interface.
- Property InterfaceSettings.IsVirtualNic gets or sets a value indicating whether this interface is the wRTOS virtual network.
- Property InterfaceSettings.JumboEnabled controls whether jumbo frames are enabled for the interface.
- Property InterfaceSettings.JumboMaxPacketSize specifies the maximum jumbo packet size in bytes if jumbo frames are enabled.
- Property InterfaceSettings.MsixMessages gets or sets the MsixMessages list populated by the NL2 InterfaceSettings object.
- Property InterfaceSettings.MsixNonQueueMessageId gets or sets the message ID for non-queue (frame transmission or frame reception) interrupts if InterruptType is RTIN_MSIX.
- Property InterfaceSettings.Name accesses the unique interface name of this NL2 interface.
- Property InterfaceSettings.NonMsixIstIdealProcessor gets or sets the non-MSIX Interrupt Service Thread (IST) ideal processor if InterruptType is RTIN_MSIX.
- Property InterfaceSettings.NonMsixIstPriority gets or sets the Interrupt Service Thread (IST) priority for non-MSI-X interrupt types if InterruptType is RTIN_MSIX.
- Property InterfaceSettings.PciBusLocation accesses the PCI bus location for this NL2 interface.
- Property InterfaceSettings.RxQueues gets or sets the RxQueues list populated by the NL2 InterfaceSettings object.
- Property InterfaceSettings.SpeedDuplex accesses the SpeedDuplexType enumeration specifying the speed/duplex type used by this interface.
- Property InterfaceSettings.TxQueues gets or sets the TxQueue list populated by the NL2 InterfaceSettings object.
- Event InterfaceSettings.PropertyChanged is triggered when a property value changes.
- Class RxQueue allows users to configure and manage a receive (Rx) queue in an NL2 interface. This class contains these members:
- Property RxQueue.BufferCount gets or sets whether timestamping is enabled for the receive queue.
- Property RxQueue.Enabled gets or sets whether the receive queue is enabled.
- Property FilterDriver gets or sets an absolute pathname to a wRTOS filter driver RTDLL. This property is ignored when FilterEnabled is false.
- Property FilterEnabled gets or sets the receive queue's filter-enabled status.
- Property RxQueue.Index gets or sets the receive queue index.
- Property RxQueue.ManagementThreadIdealProcessor gets or sets the ideal processor for the receive queue's management thread.
- Property RxQueue.ManagementThreadPriority gets or sets the priority of the receive queue's management thread.
- Property RxQueue.MSIXQueueMessageId gets or sets the MSI-X message ID associated with the receive queue.
- Property RxQueue.TimestampingEnabled gets or sets whether timestamping is enabled for the receive queue.
- Class TxQueue allows users to configure and manage a transmit (Tx) queue in an NL2 interface. This class contains these members:
- Property TxQueue.BufferCount gets or sets whether timestamping is enabled for the transmit queue.
- Property TxQueue.Enabled gets or sets whether the transmit queue is enabled.
- Property TxQueue.Index gets or sets the transmit queue index.
- Property TxQueue.ManagementThreadIdealProcessor gets or sets the ideal processor for the transmit queue's management thread.
- Property TxQueue.ManagementThreadPriority gets or sets the priority of the transmit queue's management thread.
- Property TxQueue.MSIXQueueMessageId gets or sets the MSI-X message ID associated with the transmit queue.
- Property TxQueue.TimestampingEnabled gets or sets whether timestamping is enabled for the transmit queue.
- Class MsixMessage allows users to configure and manage an MSI-X message in the NL2 interface. This class contains these members:
- Property MsixMessage.Enabled gets or sets the enabled status of an MSI-X message.
- Property MsixMessage.IstIdealProcessor gets or sets the ideal processor for the Interrupt Service Thread (IST).
- Property MsixMessage.IstPriority gets or sets the priority of the Interrupt Service Thread (IST).
- Property MsixMessage.MsixMessageId gets or sets the unique identifier of the MSI-X message.
- Added APIs for controlling and configuring the TCP/IP Stack component. (998, 7834, 7839, 7844)
- Namespace IntervalZero.MaxRT.Tcpip contains types used to configure a TCP/IP IPv4 address and subnet mask.
- Namespace IntervalZero.MaxRT.Tcpip.Config contains types used to configure the TCP/IP Stack.
- Class Component encapsulates various configuration operations for the TCP/IP Stack.
- Method Component.IsLicensed returns whether the TCP/IP Stack component has a valid license of the same major version as the installed wRTOS Runtime.
- Method Component.ResetAll resets all TCP/IP configurations to their default values.
- Method Component.ResetAutoStart resets the AutoStart parameter to its default value of zero (0).
- Method Component.ResetExtMSpacePoolMinimumSize resets the ExtMSpacePoolMinimumSize property to its default value of 6272.
- Method Component.ResetIdealProcessor resets the IdealProcessor property to its default value of zero (0).
- Method Component.ResetIPReassemblyTimeout resets the IPReassemblyTimeout property to its default value of 60.
- Method Component.ResetMaxArpEntries resets the MaxArpEntries property to its default value of 256.
- Method Component.ResetMaxConcurrency resets the MaxConcurrency property to its default value of zero (0).
- Method Component.ResetMaxSockets resets the MaxSockets property to its default value of 64.
- Method Component.ResetMemory resets the Memory property to its default value of 1024 KB.
- Method Component.ResetMSpacePoolExpandable resets the MSpacePoolExpandable property to its default value of 1.
- Method Component.ResetMSpacePoolExpandSize resets the MSpacePoolExpandSize property to its default value of 1024.
- Method Component.ResetTimerExecutePriority resets the TimerExecutePriority property to its default value of 66.
- Method Component.ResetTimerIdealProcessor resets the TimerIdealProcessor property to its default value of zero (0).
- Method Component.ResetTimerInterval resets the TimerInterval property to its default value of 100.
- Method Component.ResetTimerPriority resets the TimerPriority property to its default value of 66.
- Method Component.ResetVerbose resets the Verbose property to its default value of zero (0).
- Property Component.AutoStart gets or sets a Boolean indicating whether the TCP/IP Stack component should start automatically.
- Property Component.ExtMSpacePoolMinimumSize gets or sets the minimum size of the external memory space pool for the TCP/IP Stack.
- Property Component.IdealProcessor gets or sets the ideal processor for the TCP/IP Stack.
- Property Component.Interfaces gets a list of NetworkInterface objects representing the network interfaces enabled for TCP/IP.
- Property Component.IPReassemblyTimeout gets or sets the IP reassembly timeout value.
- Property Component.MaxArpEntries gets or sets the maximum number of ARP entries.
- Property Component.MaxConcurrency gets or sets the maximum concurrency level.
- Property Component.MaxSockets gets or sets the maximum number of sockets.
- Property Component.Memory gets or sets the memory allocation for the TCP/IP Stack.
- Property Component.MSpacePoolExpandable gets or sets a Boolean indicating whether the memory space pool is expandable.
- Property Component.MSpacePoolExpandSize gets or sets the size by which the memory space pool can expand.
- Property Component.RestartNeeded indicates whether the TCP/IP Stack needs to be restarted for configuration changes made with this class to take effect.
- Property Component.TimerExecutePriority gets or sets the execution priority of the TCP/IP Stack's timer thread.
- Property Component.TimerIdealProcessor gets or sets the ideal processor for the TCP/IP Stack's timer thread.
- Property Component.TimerInterval gets or sets the timer interval used by the TCP/IP Stack.
- Property Component.TimerPriority gets or sets the timer priority used by the TCP/IP Stack.
- Property Component.Verbose gets or sets a Boolean indicating whether verbose logging is enabled.
- Namespace IntervalZero.MaxRT.Tcpip.Control contains types used to control the TCP/IP Stack.
- Class Component encapsulates various control operations for the TCP/IP Stack.
- Method Component.Start starts the TCP/IP component.
- Method Component.Stop stops the TCP/IP component.
- Method Component.GetStatus returns the status of the TCP/IP component.
- Method Component.GetClientProcessIDs returns a list of client process IDs currently using the TCP/IP component.
- Class Ipv4Configuration represents an IPv4 address and subnet mask.
- Method Ipv4Configuration.Equals determines whether the specified Ipv4Configuration is equal to the current Ipv4Configuration.
- Property Ipv4Configuration.Ipv4Address gets or sets the IPv4 address.
- Property Ipv4Configuration.SubnetMask gets or sets the subnet mask.
- Class InterfaceSettings represents the TCP/IP settings for an interface.
- Property InterfaceSettings.AreProtocolSettingsValid indicates whether the protocol settings are valid.
- Property InterfaceSettings.Enabled indicates whether the network interface is enabled.
- Property InterfaceSettings.FilterDriver gets or sets the name of the filter driver.
- Property InterfaceSettings.FilterEnabled indicates whether the filter is enabled.
- Property InterfaceSettings.Gateway gets or sets the gateway address for the network interface.
- Property InterfaceSettings.IgnoreProtocolValidationError indicates whether to ignore protocol validation errors.
- Property InterfaceSettings.Ipv4Configurations gets or sets a list of Ipv4Configuration objects representing the IPv4 configurations.
- Property InterfaceSettings.IPv6Address gets or sets the IPv6 address of the network interface.
- Property InterfaceSettings.IPv6Prefix gets or sets the IPv6 prefix length.
- Property InterfaceSettings.LinkStatusEnabled indicates whether the link status is enabled.
- Property InterfaceSettings.LinkStatusIdealProcessor gets or sets the ideal processor for link status.
- Property InterfaceSettings.LinkStatusPriority gets or sets the priority for link status.
- Property InterfaceSettings.Name gets the name of the network interface.
- Property InterfaceSettings.ReceiveIdealProcessor gets or sets the ideal processor for TCP/IP Stack's receive thread.
- Property InterfaceSettings.ReceivePriority gets or sets the priority for the TCP/IP Stack’s receive thread for the network interface.
- Property InterfaceSettings.RxBufferCount gets or sets the receive buffer count used by the TCP/IP Stack.
- Property InterfaceSettings.RxQueueIndex gets or sets the receive queue index used by the TCP/IP Stack.
- Property InterfaceSettings.TxBufferCount gets or sets the transmit buffer count used by the TCP/IP Stack.
- Property InterfaceSettings.TxQueueIndex gets or sets the transmit queue index used by the TCP/IP Stack.
- Added a managed IntervalZero.MaxRT.Rly.Config namespace containing types used to configure the Network Relay component and its interface settings.
- Added a new managed Rly.Config.Component class that encapsulates various Network Relay configuration operations:
- Method ResetAll resets all Network Relay component configurations to their default values.
- Method ResetAutoStart resets the AutoStart property to its default of manual start (false). After calling this method, the Network Relay component must be restarted for the changes to take effect.
- Method ResetExtMSpacePoolMinimumSize resets the ExtMSpacePoolMinimumSize property to its default value of 6,272 KB. After calling this method, the Network Relay component must be restarted for the changes to take effect.
- Method ResetIdealProcessor resets the IdealProcessor property to its default value of 0xFFFFFFFF, indicating that the system default processor should be used. After calling this method, the Network Relay component must be restarted for the changes to take effect.
- Method ResetMSpacePoolExpandable resets the MSpacePoolExpandable property to its default of enabled, which is a value of 1. After calling this method, the Network Relay component must be restarted for the changes to take effect.
- Method ResetMSpacePoolExpandSize resets the MSpacePoolExpandSize property to its default value (false). After calling this method, the Network Relay component must be restarted for the changes to take effect.
- Method ResetPriority resets the Priority property to its default priority of 66. After calling this method, the Network Relay component must be restarted for the changes to take effect.
- Method ResetVerbose resets the Verbose property to its default of disabled (false). After calling this method, the Network Relay component must be restarted for the changes to take effect.
- Property AutoStart gets or sets a Boolean indicating whether the Network Relay component should start automatically.
- Property ExtMSpacePoolMinimumSize gets or sets the minimum size of the Network Relay’s external memory space pool.
- Property IdealProcessor gets or sets the ideal processor of the main thread.
- Property MSpacePoolExpandable gets or sets a Boolean indicating whether the memory space pool is expandable.
- Property MSpacePoolExpandSize gets or sets the size by which the memory space pool can expand.
- Property Priority gets or sets the priority of the main thread.
- Property RestartNeeded indicates whether the Network Relay component must be restarted for configuration changes made with this class to take effect.
- Property Verbose gets or sets a Boolean indicating whether verbose logging is enabled.
- Added a new managed Rly.Config.InterfaceSettings class that encapsulates various Network Relay interface settings:
- Method GetAllInterfaceSettings returns a list of interfaces configured for the Network Relay component.
- Method CreateInterfaceSettings(string name) creates a new InterfaceSettings object for the specified interface name.
- Property AreProtocolSettingsValid is read only. If the value is false, the protocol settings conflict with another protocol interface setting. If the value is true, the protocol settings are valid.
- Property ConfigIdealProcessor gets or sets the preferred processor for the configuration thread.
- Property ConfigPriority gets or sets the priority of the configuration thread.
- Property Enabled gets or sets whether the interface is enabled.
- Property IgnoreProtocolValidationError determines whether changes will be validated against higher-level network protocol settings on the interface.
- Property Name gets the name of the network interface.
- Property ReceiveIdealProcessor gets or sets the preferred processor for the receive thread.
- Property ReceivePriority gets or sets the priority of the receive thread.
- Property RxBufferCount gets or sets the number of receive buffers.
- Property RxQueueIndex gets or sets the receive queue index.
- Property TransmitIdealProcessor gets or sets the preferred processor for the transmit thread.
- Property TransmitPriority gets or sets the priority of the transmit thread.
- Property TxBufferCount gets or sets the number of transmit buffers.
- Property TxQueueIndex gets or sets the transmit queue index.
- Added a managed IntervalZero.MaxRT.Rly.Control namespace, which contains types used to control the Network Relay component.
- Added a managed Rly.Control.Component class that encapsulates various control operations for the Network Relay component:
- Method GetStatus queries the status of the Network Relay component.
- Method Start starts the Network Relay component. If the Network Link Layer (NL2) is not started, the NL2 will also start.
- Method Stop stops the Network Relay component.
- Added a managed IntervalZero.MaxRT namespace:
- Added a managed MaxRT.Device class, which is the base class for all classes representing hardware devices on the current machine:
- Event PropertyChanged occurs when a property value changes.
- Property ClassGuid gets the Class GUID string of the device.
- Property Description gets the Plug and Play friendly name string of the device.
- Property DeviceInstanceId gets the Plug and Play instance ID string of the device.
- Property HardwareId gets the Plug and Play hardware ID string of the device.
- Property OutOfDate indicates whether the object is out-of-date with respect to the hardware device.
- Property OwnedByRtos indicates whether the device is owned by MaxRT.
- Property PCIBusLocation gets the PCI bus location for the device as a string.
- Added a managed MaxRT.RtDevice Class, which represents a device used in the real-time environment.
- Added a managed MaxRT.InterfaceSettings class for network interface configuration:
- Property Name gets the name of a network interface.
- Added a managed MaxRT.NetworkInterfaceStatus class, which represents the status of a network interface.
- Property ErrorCode gets a Windows or wRTOS error code describing the error state.
- Property ErrorDescription gets a description for the error code retrieved by the ErrorCode property.
- Property Name gets the unifying identifier for the network interface.
- Property Status gets the current status of the network interface.
- Added a managed MaxRT.MaxRTLock class for lock objects in the MaxRT environment.
- Added a managed MaxRT.MaxRTNativeException class representing native errors in the MaxRT environment.
- Property Code gets the error code associated with the exception.
- Property DetailedMessage gets a detailed message including the error code and description.
- Property ErrorCodeString gets a string description of the error code retrieved by the Code property.
- Added a managed MaxRT.SystemErrorCode enumeration that represents system error codes used in MaxRT native exceptions.
- Added new APIs for determining component installation status and version information (4424):
- Method Product.GetComponentInfo returns component information.
- Structure Product.ComponentInfo contains version information and a readable friendly name of the specified component. This structure contains these members:
- Field BuildNumber represents the build number of the component. For example 4.5.1.1234.
- Field FriendlyName represents the friendly name of the component.
- Field MajorVersion represents the major version of the component. For example, 4.5.1.1234
- Field MinorVersion represents the minor version of the component. For example, 4.5.1.1234
- Field PatchVersion represents the patch, fix, or update version of the component. For example, 4.5.1.1234
- Added new APIs for determining Subsystem exception handling behavior (11320):
- Enumeration Subsystem.ExceptionHandling represents the available exception handling options. Enumerators from this enumeration can be assigned to property Subsystem.ExceptionHandlingMode.
- Property Subsystem.ExceptionHandlingMode accesses the Subsystem.ExceptionHandling enumeration specifying the available exception handling options used by the Subsystem.
- Added new field hasExpirationDate to structure Product.RT_LICENSE_INFO that specifies whether the license has an expiration date. This field is non-zero if this license has an expiration date. Otherwise it is zero.
- Added new enumerators to enumeration Product.RT_FEATURE_LICENSE_STATUS to support time-limited licenses. (13627):
- RT_FEATURE_STATUS_RETAIL_VALID indicates the license is a valid retail license (with or without an expiration date).
- RT_FEATURE_STATUS_RETAIL_EXPIRED indicates the license is an expired retail license.
- RT_FEATURE_STATUS_EVAL_VALID indicates the license is a valid evaluation license.
- RT_FEATURE_STATUS_RETAIL_INVALID_HOST_ID indicates the license is a dongle-based retail license for which the host ID is not present on the system.
- Added new Data Logger APIs to log variables (4099):
- Enumeration LogState identifies the status of a log command.
- Enumeration TriggerType identifies the trigger type.
- Class Channel represents a log channel. This class contains the following constructor and properties:
- Constructor Channel
- Property Channel.DataType
- Property Channel.Offset
- Property Channel.Variable
- Class Log represents a log request. This class contains the following constructor, methods and properties:
- Constructor Log
- Method Log.GetData
- Method Log.Stop
- Property Log.BufferSize
- Property Log.Channels
- Property Log.Status
- Class LogData represents the data read from the log buffer. This class contains the following constructor and properties:
- Constructor LogData
- Property LogData.PeriodUs
- Property LogData.Points
- Property LogData.TimeStamp
- Class LogStatus represents the state of a log request. This class contains the following constructor and properties:
- Constructor LogStatus
- Property LogStatus.Index
- Property LogStatus.State
- Class Point represents the value of each channel at a specific time. This class contains the following constructor and property:
- Constructor Point
- Property Point.Values
- Class Trigger represents a log trigger. This class contains the following constructor and properties:
- Constructor Trigger
- Property Trigger.Channel
- Property Trigger.Type
- Property Trigger.Value
- Added new Debug Message APIs for sending messages to Message Viewer (393):
- Enumeration DataType identifies the type of a value.
- Enumeration PrintFormat identifies the format used to print a value.
- Enumeration Severity identifies the severity of a Basic message.
- Class BasicChannel controls the Basic message channel. This class contains the following constructor, methods and properties:
- Constructor BasicChannel
- Method BasicChannel.Close
- Method BasicChannel.Dispose
- Method BasicChannel.GetCategoryName
- Method BasicChannel.GetMessage
- Method BasicChannel.Open
- Method BasicChannel.SendMessage
- Method BasicChannel.SetCategoryName
- Property BasicChannel.CategoryIndexFilter
- Property BasicChannel.IsOpened
- Property BasicChannel.SeverityFilter
- Class BasicMessage contains a basic message. This class contains the following constructor and fields:
- Constructor BasicMessage
- Field BasicMessage.AppendValues
- Field BasicMessage.Category
- Field BasicMessage.Message
- Field BasicMessage.Severity
- Field BasicMessage.Timestamp
- Field BasicMessage.Value0
- Field BasicMessage.Value1
- Field BasicMessage.Value2
- Field BasicMessage.Value3
- Class ExtendedMessage contains a Standard or Trace message. This class contains the following constructor and fields:
- Constructor ExtendedMessage
- Field ExtendedMessage.Data
- Field ExtendedMessage.Index
- Field ExtendedMessage.Instance
- Field ExtendedMessage.Message
- Field ExtendedMessage.Source
- Field ExtendedMessage.Format
- Field ExtendedMessage.Timestamp
- Field ExtendedMessage.Type
- Class StandardChannel controls a Standard message channel. This class contains the following constructor, methods and properties:
- Constructor StandardChannel
- Method StandardChannel.Close
- Method StandardChannel.Dispose
- Method StandardChannel.GetMessage
- Method StandardChannel.Open
- Method StandardChannel.SendMessage
- Property StandardChannel.IsOpened
- Property StandardChannel.SourceIndexFilter
- Property StandardChannel.TypeIndexFilter
- Class TraceChannel controls a Trace message channel. This class contains the following constructor, methods and properties:
- Constructor TraceChannel
- Method TraceChannel.Close
- Method TraceChannel.Dispose
- Method TraceChannel.GetIndexFilter
- Method TraceChannel.GetMessage
- Method TraceChannel.Open
- Method TraceChannel.SendMessage
- Method TraceChannel.SetIndexFilter
- Property TraceChannel.IsOpened
- Property TraceChannel.SourceIndexFilter
- Property TraceChannel.TypeIndexFilter
- Added new Variable Database APIs for user applications to define variables exposed to MaxRT tools and servers (4094):
- Enumeration DataType identifies the type of a value.
- Class Database controls a database. This class contains the following constructor, methods, and properties:
- Constructor Database
- Method Database.CheckStatus
- Method Database.Close
- Method Database.Delete
- Method Database.Dispose
- Property Database.Invalidated
- Property Database.IsOpened
- Property Database.Name
- Property Database.Root
- Property Database.TimeStamp
- Class DatabaseDescription describes a database. This class contains the following constructor and properties:
- Constructor DatabaseDescription
- Property DatabaseDescription.Invalidated
- Property DatabaseDescription.Name
- Property DatabaseDescription.TimeStamp
- Class Directory controls a directory. This class contains the following constructor, methods, and properties:
- Constructor Directory
- Method Directory.Browse
- Method Directory.Close
- Method Directory.CreateDirectory
- Method Directory.CreateVariable
- Method Directory.Delete
- Method Directory.Dispose
- Method Directory.OpenDirectory
- Method Directory.OpenVariable
- Method Directory.Rename
- Property Directory.IsOpened
- Property Directory.Name
- Property Directory.Size
- Class Library controls the basic message channel. This class contains the following constructor, methods, and properties:
- Constructor Library
- Method Library.BrowseDatabases
- Method Library.Close
- Method Library.CreateDatabase
- Method Library.Dispose
- Method Library.Open
- Method Library.OpenDatabase
- Method Library.StartLog
- Property Library.IsOpened
- Class Variable controls a variable. This class contains the following constructor, methods, and properties:
- Constructor Variable
- Method Variable.Close
- Method Variable.Delete
- Method Variable.Dispose
- Property Variable.Description
- Property Variable.IsOpened
- Class Variable<T> controls a variable with a value type. This class contains the following constructor and property:
- Constructor Variable<T>
- Property Variable<T>.Value
- Class VariableDescription describes a variable. This class contains the following constructor and properties:
- Constructor VariableDescription
- Property VariableDescription.Name
- Property VariableDescription.Size
- Property VariableDescription.Type
New Managed E-CAT APIs
- Added new managed APIs for E-CAT control. See New Managed E-CAT APIs under the New APIs section in the Porting from KINGSTAR topic. (461)
Enhanced APIs
This section lists the APIs included in RTX64 4.x SDKs enhanced with non-breaking changes in wRTOS 1.x SDKs.
Enhanced Real-Time APIs
| RTX64 4.x API | wRTOS 1.0 and later |
|---|---|
| RTPROCESS_INFORMATION |
Added field ProcessFlags, a bit-mask flag value that contains information about a running process. DWORD ProcessFlags |
| RT_LICENSE_INFO |
Added field HostID, which is the Host ID of the license. TCHAR hostId[HOST_ID_MAX_LENGTH] |
This section lists the APIs included in RTX64 4.x SDKs that underwent breaking changes in wRTOS 1.x SDKs.
IMPORTANT: Existing real-time applications that call these APIs may need to be updated to ensure binary compatibility with wRTOS 1.x.
Breaking Changes to Real-Time APIs
Real-Time APIs (RTAPI)
| RTX64 4.x API | wRTOS 1.0 and later |
|---|---|
|
Removed from header file Rtapi.h and added to RtssApi.h. Removed from library file Rtapi.lib and added to Startup.lib. |
|
|
Removed from header file Rtapi.h and added to RtssApi.h. |
|
|
Removed from header file Rtapi.h and added to RtssApi.h. |
|
|
Enumerator RT_FEATURE_STATUS_EVAL was renamed RT_FEATURE_STATUS_EVAL_VALID in field RT_FEATURE_LICENSE_STATUS status. Enumerator RT_FEATURE_STATUS_INVALID_HOST_ID was renamed RT_FEATURE_STATUS_RETAIL_INVALID_HOST_ID Removed field isFeatureInstalled. |
|
|
Replaced constant RT_MONITOR_COMPONENT_NAL = 2 with RT_MONITOR_COMPONENT_NL2 = 2. Removed constant RT_MONITOR_COMPONENT_ALL = 3 |
|
|
Removed from header file Rtapi.h and added to RtssApi.h. Removed from library file Rtapi.lib and added to Startup.lib. |
|
|
RTX64_MONITOR_CONTROL_OP |
Renamed WRTOS_MONITOR_CONTROL_OP. |
|
RTPROCESS_INFORMATION Structure |
Removed field EnableLocalMemory. |
Real-Time Network APIs
| RTX64 4.x API | wRTOS 1.0 and later |
|---|---|
|
RtnAddMultiRoute |
Renamed RttcpipAddMultiRoute |
|
RtnDeleteMultiRoute |
Renamed RttcpipDeleteMultiRoute |
|
RtnFrameAllocate |
Renamed RttcpipFrameAllocate |
|
RtnFrameFree |
Renamed RttcpipFrameFree |
|
RtnFrameTransmit |
Renamed RttcpipFrameTransmit |
|
RtnFrameTransmitInterface |
Renamed RttcpipFrameTransmitInterface |
|
RtnGetDeviceFromIpAddress |
Renamed RttcpipGetDeviceFromIpAddress |
|
RtnGetDeviceName |
Renamed RttcpipGetDeviceName |
|
RtnGetDevicePtr |
Renamed RttcpipGetDevicePtr |
|
RtnInstallStaticRoute |
Renamed RttcpipInstallStaticRoute |
|
RtnIsDeviceOnline |
Renamed RttcpipIsDeviceOnline |
|
RtnQueryStackHeapUsage |
Renamed RttcpipQueryStackHeapUsage |
|
RtnRemoveStaticRoute |
Renamed RttcpipRemoveStaticRoute |
Breaking Changes to Configure and Control (RTFW) APIs
| RTX64 4.x API | wRTOS 1.0 and later |
|---|---|
|
RTFW_LOCAL_MEMORY_CONFIGURATION Structure |
Removed member EnableLocalMemory. |
|
RTFW_CONSOLE_CONFIGURATION_EX |
Renamed RTFW_CONSOLE_CONFIGURATION |
| RtfwGetConsoleConfigurationEx | Renamed RtfwGetConsoleConfiguration |
|
RtfwGetTCPIPClientProcessIDs |
Renamed RtfwtcpipClientProcessIDs. |
|
RTFW_PRIORITY_INVERSION_PROTOCOL |
Constant RTPI_NONE was renamed RTPI_DISABLED. Constant RTPI_TIERED_DEMOTION was renamed RTPI_ENABLED. |
| RtfwSetConsoleConfigurationEx | Renamed RtfwSetConsoleConfiguration |
Breaking Changes to Managed APIs
Note: Managed libraries and class layouts changed between RTX64 and wRTOS 1.x. See Project Settings for more information on library changes.
| RTX64 4.x API | wRTOS 1.0 and later |
|---|---|
|
Class Diagnostics.RTPerformance |
Renamed Diagnostics.RtPerformance |
|
Class Diagnostics.RTProcess |
Renamed Diagnostics.RtProcess |
|
Interface Diagnostics.IDiagnosticsRTProcess |
Renamed Diagnostics.IDiagnosticsRtProcess |
|
Class IO.RTBus |
Renamed IO.RtBus |
|
Class IO.RTInterruptHandler |
Renamed IO.RtInterruptHandler |
|
Class IO.RTMappedMemory |
Renamed IO.RtMappedMemory |
|
Class IO.RTPCISLot |
Renamed IO.RtPCISLot |
|
Class IO.RTPort |
Renamed IO.RtPort |
|
Class IO.RTPort8 |
Renamed IO.RtPort8 |
|
Class IO.RTSharedMemory |
Renamed IO.RtSharedMemory |
|
Class InteropServices.RTHandle |
Renamed InteropServices.RtHandle |
|
Class InteropServices.RTMarshal |
Renamed InteropServices.RtMarshal |
|
Enumeration InteropServices.RTHandleType |
Renamed InteropServices.RtHandleType |
|
Class Threading.RTEventWaitHandle |
Renamed Threading.RtEventWaitHandle |
|
Class Threading.RTMutex |
Renamed Threading.RtMutex |
|
Class Threading.RTSemaphore |
Renamed Threading.RtSemaphore |
|
Class Threading.RTTimer |
Renamed Threading.RtTimer |
|
Class Threading.RTWaitHandle |
Renamed Threading.RtWaitHandle |
|
Delegate Threading.RTTimerCallback |
Renamed Threading.RtTimerCallback |
|
Class Threading.WaitHandles.RTSafeWaitHandle |
Renamed Threading.WaitHandles.RtSafeWaitHandle |
|
Enumeration Product.RT_FEATURE_LICENSE_STATUS |
Renamed enumerator RT_FEATURE_STATUS_EVAL to RT_FEATURE_STATUS_EVAL_VALID |
|
Enumeration Product.RT_FEATURE_LICENSE_STATUS |
Renamed enumerator RT_FEATURE_STATUS_INVALID_HOST_ID to RT_FEATURE_STATUS_RETAIL_INVALID_HOST_ID |
|
Monitor.Subsystem.MonitorComponent Enumeration |
Replaced member NAL (2) with NL2 (2). Removed member ALL (3) |
|
Method Product.GetFeatureLicense |
Renamed Product.GetLicenseInfo |
|
Property Device.Rtx64Devices |
Renamed Device.wRTOSDevices |
|
Property Device.Rtx64NetworkDevices |
Renamed Device.wRTOSNetworkDevices |
|
Property Device.OwnedByRTX64 |
Renamed Device.OwnedByRtos |
|
Event Config.RTX64Device |
Renamed Config.wRTOSDevice |
|
Interface Config.IConfigRTX64Device |
Renamed Config.IConfigwRTOSDevice |
|
Property Subsystem.DisableSpeedStep |
Renamed Subsystem.DisableWindowsIdleDetection |
|
Method Subsystem.ResetDisableSpeedStep |
Renamed Subsystem.ResetDisableWindowsIdleDetection |
Breaking Changes to Error Codes
Real-Time APIs
| RTX64 4.x Error Code | wRTOS 1.0 and later |
|---|---|
| RT_ERROR_MONITORING_ALREADY_ENABLED | Renamed RT_ERROR_MONITORING_ENABLED |
| RT_ERROR_MONITORING_ALREADY_DISABLED | Renamed RT_ERROR_MONITORING_DISABLED |
| RT_ERROR_MONITORING_ALREADY_STARTED | Renamed RT_ERROR_MONITORING_STARTED |
| RT_ERROR_MONITORING_ALREADY_STOPPED | Renamed RT_ERROR_MONITORING_STOPPED |
| RT_ERROR_MONITORING_ALREADY_PAUSED | Renamed RT_ERROR_MONITORING_PAUSED |
This section lists RTX64 4.x APIs that were either removed from or are deprecated in wRTOS 1.x SDKs.
Removed/Deprecated Real-Time APIs
| RTX64 4.x API | wRTOS 1.0 and later |
|---|---|
|
RtAllocateLocalMemory |
Removed. Use RtAllocateLocalMemoryEx. |
| RtAllocateLockedMemory | Removed. Use RtAllocateLocalMemoryEx. |
|
RtFreeLockedMemory |
Removed. Use RtFreeLocalMemory. |
|
RtDisablePortIo |
Removed. |
|
RtEnablePortIo |
Removed. |
|
RtGetModuleFileName |
Removed. Use RtGetModuleFileNameEx. |
|
RtIsDefaultLocalMemory |
Removed. |
|
RtIsTcpStackLicensed |
Removed. |
|
RtGetThreadTimeQuantum |
Removed. Use RtGetTimeQuantum. |
|
RtGetThreadTimeQuantumEx |
Removed. Use RtGetTimeQuantum. |
|
RtMonitorEnableComponents |
Removed. |
|
RtMonitorGetEnabledComponents |
Removed. |
|
RtQueryComponent |
Removed. |
|
RtSetThreadTimeQuantum |
Removed. Use RtSetTimeQuantum. |
|
RtSetThreadTimeQuantumEx |
Removed. Use RtSetTimeQuantum. |
|
RtSleepEx |
Removed. Use SleepEx. |
| RtStartComponent |
Removed. Use these component-specific functions:
|
|
RtStopComponent |
Removed. Use these component-specific functions:
|
|
RTSSCOMPONENT |
Removed. |
Windows Driver IPC APIs
| RTX64 4.x API | wRTOS 1.0 and later |
|---|---|
|
RtkIsNetworkLicensed |
Removed. |
|
RtkIsNetworkLicensedEx |
Removed. |
|
RtkIsRuntimeLicensed |
Removed. |
|
RtkIsRuntimeLicensedEx |
Removed. |
Real-Time Network APIs
| RTX64 4.x API | wRTOS 1.0 and later |
|---|---|
|
RtnDecodePacket |
Removed. |
|
RtnDeleteCriticalLock |
Removed. |
|
RtnDisplayNbrCacheTable |
Removed. |
|
RtnDisplayRoutingTable |
Removed. |
|
RtnEnterCriticalLock |
Removed. |
|
RtnEnumPciCards |
Removed. |
|
RtnGetDataLong |
Removed. |
|
RtnGetIpAddress |
Removed. |
|
RtnGetMcastCount |
Removed. |
|
RtnGetMsPerTick |
Removed. |
|
RtnGetPacket |
Removed. |
|
RtnIndicateStatus |
Removed. |
|
RtnInitializeCriticalLock |
Removed. |
|
RtnIOCTLDriver |
Removed. |
|
RtnIsStackOnline |
Removed. Use RttcpipGetComponentStatus instead. |
|
RtnLeaveCriticalLock |
Removed. |
|
RtnNotifyRecvQueue |
Removed. |
|
RtnNotifyTransmitQueue |
Removed. |
|
RtnRequest |
Removed. |
|
RtnSetDataLong |
Removed. |
|
RtnSetLinkAddress |
Removed. |
|
RtnSetDefaultGateway |
Removed. |
|
RtnTransmitCompleteCallback |
Removed. |
Real-Time Network Driver (RTND) APIs
| RTX64 4.x API | wRTOS 1.0 and later |
|---|---|
|
RtndAttachToReceiveQueue |
Removed. |
|
RtndAttachToTransmitQueue |
Removed. |
|
RtndConfigure |
Removed. |
|
RtndDetachReceiveQueue |
Removed. |
|
RtndDetachTransmitQueue |
Removed. |
|
RtndInitDriverializeInterface |
Removed. |
|
RtndIoctl |
Removed. |
|
RtndReceive |
Removed. |
|
RtndReceiveWithCallback |
Removed. |
|
RtndRequest |
Removed. |
|
RtndServiceTransmitQueue |
Removed. |
|
RtndTransmit |
Removed. |
|
RtndTransmitEx |
Removed. |
|
RtndUpDown |
Removed. |
|
DrvISR |
Removed. |
| RTND_MEDIA_CONNECT_STATE |
Removed. |
| RTND_MEDIA_DUPLEX_STATE |
Removed. |
| RTND_MEDIA_SPEED |
Removed. |
| RTND_REQUEST |
Removed. |
| RTND_STATISTICS_INFO |
Removed. |
| RTND_STATUS |
Removed. |
| RTNAL_ETHERNET_FILTER |
Removed. |
| RTNAL_FRAME |
Removed. |
| RTNAL_HW_TIME |
Removed. |
| RTNAL_INTERFACE |
Removed. |
| RTNAL_PCI_LOCATION |
Removed. |
| RTNAL_PTP_SET_TIMESTAMP_TYPE_ARGUMENTS |
Removed. |
| RTNAL_PTP_MESSAGE_TYPE |
Removed. |
| RTNAL_PTP_VERSION |
Removed. |
| RTNAL_PHYSICAL_ADDRESS |
Removed. |
Removed/Deprecated Winsock APIs
| RTX64 4.x API | wRTOS 1.0 and later |
|---|---|
| gethostbyname | Removed. |
Removed/Deprecated Configure and Control (RTFW) APIs
| RTX64 4.x API | wRTOS 1.0 and later |
|---|---|
|
RtfwGetConsoleConfiguration |
Removed. Use RtfwGetConsoleConfiguration. |
|
RtfwSetConsoleConfiguration |
Removed. Use RtfwSetConsoleConfiguration. |
|
RtfwCreateNetworkInterface |
Removed. Use Rtfwnl2SetInterfaceSettings. |
|
RtfwDeleteNetworkInterface |
Removed. Use Rtfwnl2DeleteInterface. |
|
RtfwGetAllNetworkInterfaces |
Removed. Use Rtfwnl2GetAllInterfaces to return the configurations of all Network Link Layer (NL2) interfaces. Use RtfwtcpipGetAllInterfaces to enumerate all Network Link Layer (NL2) interfaces with TCP/IP settings. |
|
RtfwGetNALClientProcessIDs |
Removed. wRTOS 1.0 provides a Network Link Layer (NL2) that replaces the NAL from RTX64 4.x versions. Use Rtfwnl2GetClientProcessIDs. |
| RtfwGetNALConfiguration | Removed. wRTOS 1.0 provides a Network Link Layer (NL2) that replaces the NAL from RTX64 4.x versions. Use Rtfwnl2GetConfiguration. |
|
RtfwGetNALLocalMemoryConfiguration |
Removed. wRTOS 1.0 provides a Network Link Layer (NL2) component that replaces the NAL from RTX64 4.x versions. Use Rtfwnl2GetConfiguration. |
|
RtfwGetNALStatus |
Removed. wRTOS 1.0 provides a Network Link Layer (NL2) component that replaces the NAL from RTX64 4.x versions. Use RtNL2GetComponentStatus. |
|
RtfwGetNetworkInterfaceByName |
Removed. Use Rtfwnl2GetInterface. |
|
RtfwGetNetworkInterfacesStatus |
Removed. |
|
RtfwGetNetworkVerbosity |
Removed. wRTOS 1.0 provides a Network Link Layer (NL2) component that replaces the NAL from RTX64 4.x versions. Use Rtfwnl2GetVerbosity or RtfwtcpipGetVerbosity. |
|
RtfwGetTCPIPClientProcessIDs |
Removed. Use RtfwtcpipGetClientProcessIDs. |
|
RtfwGetTCPIPConfiguration |
Renamed RtfwtcpipGetConfiguration. |
|
RtfwGetTCPIPLocalMemoryConfiguration |
Removed. Use RtfwtcpipGetConfiguration. |
|
RtfwGetTCPIPStatus |
Removed. Use RttcpipGetComponentStatus. |
|
RtfwGetRTX64Devices |
Removed. Use RtfwGetwRTOSDevices. |
|
RtfwGetRTX64DevicesEx |
Removed. Use RtfwGetwRTOSDevices. |
| RtfwSetNALConfiguration | Removed. wRTOS 1.0 provides a Network Link Layer (NL2) component that replaces the NAL from RTX64 4.x versions. Use Rtfwnl2SetConfiguration. |
|
RtfwSetNALLocalMemoryConfiguration |
Removed. wRTOS 1.0 provides a Network Link Layer (NL2) component that replaces the NAL from RTX64 4.x versions. Use Rtfwnl2SetConfiguration. |
|
RtfwSetNetworkVerbosity |
Removed. wRTOS 1.0 provides a Network Link Layer (NL2) component that replaces the NAL from RTX64 4.x versions. Use Rtfwnl2GetVerbosity. |
|
RtfwSetTCPIPConfiguration |
Renamed RtfwtcpipGetConfiguration. |
|
RtfwSetTCPIPLocalMemoryConfiguration |
Removed. Use RtfwtcpipGetConfiguration. |
|
RtfwStartNAL |
Removed. wRTOS 1.0 provides a Network Link Layer (NL2) component that replaces the NAL from RTX64 4.x versions. Use Rtnl2StartComponent in Rtfwnl2Api.dll. |
|
RtfwStartTCPIPStack |
Removed. Use RttcpipStartComponent in RtfwtcpipApi.dll. |
|
RtfwStopNAL |
Removed. wRTOS 1.0 provides a Network Link Layer (NL2) component that replaces the NAL from RTX64 4.x versions. Use Rtnl2StopComponent in Rtfwnl2Api.dll. |
|
RtfwStopTCPIPStack |
Removed. Use RttcpipStopComponent in RtfwtcpipApi.dll. |
|
RTFW_CONSOLE_CONFIGURATION |
Removed. Use RTFW_CONSOLE_CONFIGURATION. |
|
RTFW_DEVICE |
Removed. Use RTFW_DEVICEEX. |
|
RTFW_NAL_CONFIGURATION |
Removed. wRTOS 1.0 provides a Network Link Layer (NL2) component that replaces the NAL from RTX64 4.x versions. Use RTFW_NL2_CONFIGURATION. |
|
RTFW_NETWORK_INTERFACE |
Removed. Use RTFW_NL2_INTERFACE for NL2 interfaces. Use RTFW_TCPIP_INTERFACE for TCP/IP interfaces. |
|
RTFW_NETWORK_INTERFACE_STATUS |
Removed. |
Removed/Deprecated Managed APIs
| RTX64 4.x API | wRTOS 1.0 and later |
|---|---|
|
IntervalZero.MaxRT.wRTOS.RtApi.Runtime.InteropServices Namespace |
Removed, along with:
|
|
RTX64Object.CreationTime Property |
Removed. |
|
RTX64Object.Name Property |
Removed. |
|
Config.ServerConsole |
These properties were removed:
|
|
Config.Subsystem.FreezeFaultingProcessOnException property Config.Subsystem.ExceptionBehavior property Config.Subsystem.UseStructuredExceptionHandling property |
Replaced by these new Managed APIs:
|
|
Config.ScheduledProcess.UseLocalMemory Property |
Removed. |
|
Config.IConfigNetwork Interface |
Removed. |
|
Config.IConfigNetworkFilter Interface |
Removed. |
|
Config.IConfigNetworkInterface Interface |
Removed. |
|
Config.IConfigTCPIP Interface |
Removed. |
|
Config.IConfigIPv4Configuration Interface |
Removed. |
|
Config.IPv4AddressNetMaskPair Structure |
Removed. |
|
Config.IPv4Configuration Class |
Removed. |
|
Config.Network Class |
Removed. |
|
Config.NetworkFilter Class |
Removed. |
|
Config.NetworkInterface Class |
Removed. |
|
Config.TCPIP Class |
Removed. |
|
Config.NetworkInterface.InterruptType Enumeration |
Removed. |
|
Config.NetworkInterface.SpeedDuplexType Enumeration |
Removed. |
|
Control.Subsystem.StartNAL |
Removed. Use NL2.Control.Start. |
|
Control.Subsystem.StopNAL |
Removed. Use NL2.Control.Stop. |
|
Control.Subsystem.GetNALStatus |
Removed. Use NL2.Control.GetStatus. |
|
Control.Subsystem.StartTcpipStack |
Removed. Use Tcpip.Control.Start. |
|
Control.Subsystem.StopTcpipStack |
Removed. Use Tcpip.Control.Stop. |
|
Control.Subsystem.GetTCPIPStatus |
Removed. Use Tcpip.Control.GetStatus. |
|
Control.Subsystem.NetworkInterfaceStatus |
Removed. |
|
Control.Subsystem.GetNetworkInterfacesStatus |
Removed. |
|
Control.Subsystem.NetworkControlRegion |
Removed. |
|
Control.Subsystem.StateEx Property |
Merged with and replaced by the Control.Subsystem.State property. |
|
RtApi.Diagnostics.RTProcess.Start Method |
Removed these overloads:
|
|
Monitor.Subsystem.EnableComponents Method |
Removed. |
|
Monitor.Subsystem.GetEnabledComponents Method |
Removed. |
|
Monitor.MonitorEventContiguousMemoryAlloc Class |
Removed the class and all its members. |
|
Monitor.MonitorEventContiguousMemoryAllocFail Class |
Removed the class and all its members. |
|
Monitor.MonitorEventContiguousMemoryAllocSpecifyCache Class |
Removed the class and all its members. |
|
Monitor.MonitorEventContiguousMemoryAllocSpecifyCacheFail Class |
Removed the class and all its members. |
|
Monitor.MonitorEventContiguousMemoryFree Class |
Removed the class and all its members. |
|
Monitor.MonitorEventContiguousMemoryFreeFail Class |
Removed the class and all its members. |
|
Monitor.MonitorEventWindowsMemoryAlloc Class |
Removed the class and all its members. |
|
Monitor.MonitorEventWindowsMemoryAllocFail Class |
Removed the class and all its members. |
|
Monitor.MonitorEventWindowsMemoryFree Class |
Removed the class and all its members. |
|
Monitor.MonitorEventWindowsMemoryFreeFail Class |
Removed the class and all its members. |
|
Monitor.MonitorEventShutdownHandlerCall Class |
Removed the class and all its members. |
|
Monitor.MonitorEventLocalMemoryExpand Class |
Removed the class and all its members. |
|
Monitor.MonitorEventLocalMemoryShrink Class |
Removed the class and all its members. |
|
Config.Subsystem.EnableLocalMemory Property |
Removed. |
|
Config.Subsystem.ResetEnableLocalMemory Method |
Removed |
Removed Error Codes
Real-Time APIs
| RTX64 4.x Error Code | wRTOS 1.0 and later |
|---|---|
| RT_ERROR_MONITORING_IS_STARTED | Removed. |
| RT_ERROR_MONITORING_NOT_ENABLED | Removed. |
| RT_ERROR_MONITORING_INVALID_STATE_TRANSITION | Removed. |
Related topics:
