NetworkInterface Class |
This class represents a single network interface.
Inheritance HierarchyAssembly: IntervalZero.RTX64 (in IntervalZero.RTX64.dll) Version: 4.0.0.0 (File version: 4.5.0)
SyntaxThe NetworkInterface type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | CreationTime | Date and time the object was created. (Inherited from RTX64Object.) |
| DefaultReceiveQueue | The default receive queue for this interface. The default is 0. |
| DeviceInstanceID | Access the device Instance ID of the device used by this network interface. This property is optional: it can be set to the empty string without altering the behavior of this class. No two NetworkInterface objects can have the same device Instance IDs (with the exception of the empty string). |
| Driver | Access the name of the driver for this network interface. The value of this property is either the absolute pathname of an RTDLL driver for this network device or the file name of the RTDLL driver for this network device. In the latter case, the ".rtdll" suffix on the file name is optional. |
| Enabled | Controls whether the interface is enabled or disabled. New interfaces are enabled by default. Set this property to true to enable the interface or to false to disable the interface. |
| FriendlyName | Accesses the unique friendly name of this network interface. Case is preserved in the value assigned to this property, but case is ignored when comparing the value of this property to any string, such as when creating or deleting interfaces by their FriendlyName. Thus, after creating an interface with FriendlyName "MainInterface" one cannot create another interface with the FriendlyName "MAINinterface", because the two names will compare equal -- and two interfaces cannot have the same FriendlyName. |
| Gateway | Accesses the layer 3 gateway for this network interface. |
| Interrupt | Accesses an enumeration specifying what type of interrupt mechanism this interface uses. This property should not be altered if the interface is for the Virtual Network. |
| InterruptIdealProcessor |
Accesses the ideal processor for the interface's interrupt service thread. This is a non-negative integer
that specifies an RTSS processor. Even though processor 0 is always a Windows processor, the special value
0 for this property refers to the first RTSS processor, which is useful when the number of the first RTSS
processor may change over time.
NOTE: Processor numbers are zero-based, and the first 0 to N-1 processors are always Windows processors, where N is the number of configured Windows processors. After changing this property, the RT- TCP/IP stack must be restarted for the changes to take effect. This Property should not be altered if the interface is for the Virtual Network. |
| InterruptPriority | Accesses the Interrupt Priority for this network interface. |
| Ipv4Address | Returns the IPv4 address (in dotted-quad notation) for this network interface. |
| IPv4Configurations | This is a ReadOnly Property which displays all the IpConfigurations of this particular network Interface. This property can only be used in RTX64 3.2 or later. |
| Ipv6Address | Accesses the IPv6 address for this network interface. |
| Ipv6Prefix | Accesses the IPv6 network prefix for this network interface. |
 | IsDisposed | True if the object has been disposed, false otherwise. (Inherited from RTX64Object.) |
| LinkStatus | Monitor the link status for a given interface. This property should not be altered if the interface is for the Virtual Network. |
| LinkStatusIdealProcessor |
The ideal processor for the interface's link status thread. The specified value must be a valid RTSS processor. This property is optional.
NOTE: Processor numbers are zero based. By default, the first RTSS processor is the ideal processor. This property should not be altered if the interface is for the Virtual Network. |
| LinkStatusPriority |
The RT-TCP/IP stack's link status thread priority.
This property should not be altered if the interface is for the Virtual Network.
|
| MaxPacketSize | The maximum packet size, in bytes. The default is 1514. |
| Mtu | Accesses the Maximum Transmission Unit (MTU) size, in bytes, for this network interface. |
| Name | Name of the object. (Inherited from RTX64Object.) |
| Netmask | Returns the network mask for this network interface. |
| NumReceiveBuffers | Access the number of receive buffers used by this network interface. |
| NumTransmitBuffers | Accesses the number of transmit buffers used by this network interface. |
| NumberReceiveQueues | The total number of receive queues for this interface. The default is 1. |
| NumberTransmitQueues | The total number of transmit queues for this interface. The default is 1. |
| PciBusLocation |
Accesses the PCI bus location for this network interface. The value of this property is a string of the
form "X;Y;Z", where X, Y, and Z are the integer bus, device, and function values (respectively) for the device. The
empty string and the value "0;0;0" are synonymous and mean that this network interface has no PCI bus
location specified. The PCI bus location of a device can be obtained from the Windows Device Manager by
opening the device's Properties: the General tab of the Properties dialog will display the
bus/device/function values for that device.
NOTE: If multiple RTX64 network interfaces use the same real-time driver (see property Driver on this class), then _all_ of those interfaces must have a valid PCI bus location specified. This Property should not be altered if the interface is for the Virtual Network. |
| ReceiveIdealProcessor |
Accesses the ideal processor for the interface's receive thread. This is a non-negative integer that
specifies an RTSS processor. Even though processor 0 is always a Windows processor, the special value 0 for
this property refers to the first RTSS processor, which is useful when the number of the first RTSS
processor may change over time.
NOTE: Processor numbers are zero-based, and the first 0 to N-1 processors are always Windows processors, where N is the number of configured Windows processors. After changing this property, the RT-TCP/IP stack must be restarted for the changes to take effect. This property should not be altered if the interface is for the Virtual Network. |
| ReceivePriority | Accesses the RT-TCP/IP stack's receive thread priority for this network interface. |
| SpeedDuplexType | Accesses an enumeration which specifies the method used to establish the Ethernet link. |
| SupportTCPIP | Adds support for RT-TCP/IP functionality to the interface. |
| TransmitCompleteIdealProcessor | The ideal processor number for the real-time transmit thread for this interface. |
| TransmitCompletePriority | The real-time priority of the transmit thread for this interface. Valid values are in the range 0 to 127 (inclusive). |
Methods| Name | Description | |
|---|---|---|
 | AddIPConfiguration |
Adds an IPv4Address and Netmask paired to the interface. This method can only be used
in RTX64 3.2 or later.
|
| CreateNetworkFilter |
Create a new filter for this network interface..
|
| DeleteIPConfiguration |
Deletes an IpConfiguration from a NetworkInterface. This property can only be used in RTX64 3.2 or later.
|
| DeleteNetworkFilter |
Delete an existing filter.
|
| Dispose |
Dispose method.
(Inherited from RTX64Object.) |
| GetAllNetworkFilters |
Returns an array of IConfigNetworkFilter interface references, each representing one network filter
configured on this network interface. If no network filters are configured on this network interface,
returns an empty array.
|
| GetNetworkFilterByDriver |
Get the filter driver name by driver.
|
| ModifyIPConfiguration |
Modifies an IpConfiguration from a NetworkInterface. This is used to modify the netmask of an Exist IPv4Address.
This property can only be used in RTX64 3.2 or later.
|
 | OnNotifyPropertyChanged |
Called when a property is changed
(Inherited from RTX64Object.) |
Events| Name | Description | |
|---|---|---|
 | PropertyChanged |
Event Fired when a property value is changed
(Inherited from RTX64Object.) |
See Also