IntervalZero RTX64 Managed Code Framework

Network.CreateNetworkInterface Method(String, String, Bool, IPv4AddressNetMaskPair, NetworkInterface.SpeedDuplexType, String, UInt32, UInt32, Bool, String, String, UInt32, UInt32, String, UInt32, UInt32, NetworkInterface.InterruptType, UInt32, UInt32, UInt32, UInt32, UInt32, UInt32, UInt32, UInt32)

Creates an RTX64 network interface.

Namespace: IntervalZero.RTX64.Config
Assembly: IntervalZero.RTX64 (in IntervalZero.RTX64.dll) Version: 4.0.0.0 (File version: 4.5.0)

Syntax

C++

Copy

public IConfigNetworkInterfaceCreateNetworkInterface(
	string name,
	string driver,
	bool supportTCPIP,
	IPv4AddressNetMaskPair[] IPConfigurations,
        NetworkInterface.SpeedDuplexType speedDuplex,
	string deviceInstanceID = "",
	uint receiveIdealProcessor = 0,
	uint interruptIdealProcessor = 0,
	bool linkStatus = true,
	string gateway = "0.0.0.0",
	string pciBusLocation = "0;0;0",
	uint interruptPriority = 64,
	uint mtu = 1500,
	string ipv6Address = "Auto",
        uint ipv6Prefix = 64,
	uint receivePriority = 63,
	NetworkInterface.InterruptType interrupt = NetworkInterface.InterruptType.DEVICE_DEFAULT,
	uint numReceiveBuffers = 256,
	uint numTransmitBuffers = 256,                                  
	uint maxPacketSize = NetworkInterface.MAXPACKETSIZE_DEFAULT_VALUE,
	uint defaultReceiveQueue = NetworkInterface.DEFAULTQUEUE_DEFAULT_VALUE,
	uint numberOfReceiveQueues = NetworkInterface.NUMBEROFRECEIVEQUEUES_DEFAULT_VALUE,
	uint numberOfTransmitQueues = NetworkInterface.NUMBEROFXMITQUEUES_DEFAULT_VALUE,
	uint transmitCompletePriority = NetworkInterface.XMITCOMPLETEPRIORITY_DEFAULT_VALUE,
	uint transmitCompleteIdealProc = NetworkInterface.XMITCOMPLETEIDEALPROCESSOR_DEFAULT_VALUE)
)

public Function CreateNetworkInterface ( 
	name As String,
	driver As String,
	supportTCPIP As Boolean = true
	IPConfigurations As IPv4AddressNetMaskPair(),
       NetworkInterface.SpeedDuplexType As speedDuplex,
	Optional deviceInstanceID As String = "",
	Optional receiveIdealProcessor As UInteger = 0,
	Optional interruptIdealProcessor As UInteger = 0,
	Optional linkStatus As Boolean = true,
	Optional gateway As String = "0.0.0.0",
	Optional pciBusLocation As String = "0;0;0",
	Optional interruptPriority As UInteger = 64,
	Optional mtu As UInteger = 1500,
	Optional ipv6Address As String = "Auto",
	Optional ipv6Prefix As UInteger = 64,
	Optional receivePriority As UInteger = 63,
	Optional interrupt As NetworkInterface.InterruptType = NetworkInterface.InterruptType.DEVICE_DEFAULT,
	Optional numReceiveBuffers As UInteger = 256,
	Optional numTransmitBuffers As UInteger = 256
	Optional uint maxPacketSize As NetworkInterface.MAXPACKETSIZE_DEFAULT_VALUE,
	Optional defaultReceiveQueue As NetworkInterface.DEFAULTQUEUE_DEFAULT_VALUE,
	Optional numberOfReceiveQueues As NetworkInterface.NUMBEROFRECEIVEQUEUES_DEFAULT_VALUE,
	Optional numberOfTransmitQueues As NetworkInterface.NUMBEROFXMITQUEUES_DEFAULT_VALUE,
	Optional transmitCompletePriority As NetworkInterface.XMITCOMPLETEPRIORITY_DEFAULT_VALUE,
	Optional transmitCompleteIdealProc As NetworkInterface.XMITCOMPLETEIDEALPROCESSOR_DEFAULT_VALUE
) As IConfigNetworkInterface

public IConfigNetworkInterface^ CreateNetworkInterface(
	String^ name, 
	String^ driver,
	boolsupportTCPIP = true,  
	array<IPv4AddressNetMaskPair>^ IPConfigurations, 
       NetworkInterface.SpeedDuplexType speedDuplex = NetworkInterface.SpeedDuplexType.speedDuplex,
	String^ deviceInstanceID = L"", 
	unsigned int receiveIdealProcessor = 0, 
	unsigned int interruptIdealProcessor = 0, 
	bool linkStatus = true, 
	String^ gateway = L"0.0.0.0", 
	String^ pciBusLocation = L"0;0;0",
	unsigned intinterruptPriority = 64,
	unsigned intmtu = 1500,
	String^ ipv6Address = "Auto",
       unsigned intipv6Prefix = 64,
	unsigned intreceivePriority = 63,
	NetworkInterface.InterruptTypeinterrupt = NetworkInterface.InterruptType.DEVICE_DEFAULT,
	uintunsigned intnumReceiveBuffers = 256,
	uintunsigned intnumTransmitBuffers = 256,
	unsigned int maxPacketSize = NetworkInterface.MAXPACKETSIZE_DEFAULT_VALUE,
       unsigned int defaultReceiveQueue = NetworkInterface.DEFAULTQUEUE_DEFAULT_VALUE,
       unsigned int numberOfReceiveQueues = NetworkInterface.NUMBEROFRECEIVEQUEUES_DEFAULT_VALUE,
       unsigned int numberOfTransmitQueues = NetworkInterface.NUMBEROFXMITQUEUES_DEFAULT_VALUE,
       unsigned int transmitCompletePriority = NetworkInterface.XMITCOMPLETEPRIORITY_DEFAULT_VALUE,
       unsigned int transmitCompleteIdealProc = NetworkInterface.XMITCOMPLETEIDEALPROCESSOR_DEFAULT_VALUE
)

public abstract CreateNetworkInterface : 
        ?name : string * 
        ?driver : string *
        ?supportTCPIP : bool *
        ?IPConfigurations : IPv4AddressNetMaskPair[] *
        ?speedDuplex : NetworkInterface.SpeedDuplexType *
        ?deviceInstanceID : string * 
        ?receiveIdealProcessor : uint32 * 
        ?interruptIdealProcessor : uint32 * 
        ?linkStatus : bool *  
        ?gateway : string * 
        ?pciBusLocation : string * 
        ?interruptPriority : uint32 * 
        ?mtu : uint32 * 
        ?ipv6Address : string * 
        ?ipv6Prefix : uint32 * 
        ?receivePriority : uint32 * 
        ?interrupt : NetworkInterface.InterruptType * 
        ?numReceiveBuffers : uint32 * 
        ?numTransmitBuffers : uint32
	 ?maxPacketSize : uint32 * 
        ?defaultReceiveQueue : uint32 *
	 ?numberOfReceiveQueues : uint32 * 
        ?numberOfTransmitQueues : uint32 *
	 ?transmitCompletePriority : uint32 * 
        ?transmitCompleteIdealProc : uint32 *
(* Defaults:

        let _supportTCPIP = defaultArg supportTCPIPtrue
        let _deviceInstanceID = defaultArg deviceInstanceID ""
        let _receiveIdealProcessor = defaultArg receiveIdealProcessor 0
        let _interruptIdealProcessor = defaultArg interruptIdealProcessor 0
        let _linkStatus = defaultArg linkStatus true
        let _gateway = defaultArg gateway "0.0.0.0"
        let _pciBusLocation = defaultArg pciBusLocation "0;0;0"
        let _interruptPriority = defaultArg interruptPriority 64
        let _mtu = defaultArg mtu 1500
        let _ipv6Address = defaultArg ipv6Address "Auto"
        let _ipv6Prefix = defaultArg ipv6Prefix 64
        let _receivePriority = defaultArg receivePriority 63
        let _interrupt = defaultArg interrupt NetworkInterface.InterruptType.DEVICE_DEFAULT
        let _numReceiveBuffers = defaultArg numReceiveBuffers 256
        let _numTransmitBuffers = defaultArg numTransmitBuffers 256
	 let _maxPacketSize = defaultArg NetworkInterface.MAXPACKETSIZE_DEFAULT_VALUE,
        let _defaultReceiveQueue = defaultArg NetworkInterface.DEFAULTQUEUE_DEFAULT_VALUE,
        let _numberOfReceiveQueues = defaultArg NetworkInterface.NUMBEROFRECEIVEQUEUES_DEFAULT_VALUE,
        let _numberOfTransmitQueues = defaultArg NetworkInterface.NUMBEROFXMITQUEUES_DEFAULT_VALUE,
        let _transmitCompletePriority = defaultArg NetworkInterface.XMITCOMPLETEPRIORITY_DEFAULT_VALUE,
        let _transmitCompleteIdealProc = defaultArg NetworkInterface.XMITCOMPLETEIDEALPROCESSOR_DEFAULT_VALUE
*)
-> IConfigNetworkInterface

Parameters

name

Specifies the unique name of the interface within the RT-TCP/IP stack instance.

driver

Specifies the name of the Real-time network device (Rtnd) driver for this interface, which is either the file name of the RTDLL implementing the driver or the full pathname to the RTDLL implementing the driver. In either case, the suffix .rtdll must be included.

supportTCPIP

Determines whether the interface supports TCP/IP.

IPConfigurations

Specifies an array of IPv4 addresses and netmasks assigned to this interface. If the interface has no IPv4 addresses, set element 0 of this array to specify IPv4 address 0.0.0.0 and netmask 0.0.0.0, and also set member CountIPv4Configurations to 1.

speedDuplex

The method used to establish the Ethernet link. See NetworkInterface.SpeedDuplexType for more information.

receiveIdealProcessor

Specifies the ideal processor for receive processing.

interruptIdealProcessor

Specifies the ideal processor for interrupt processing.

linkStatus

Specifies whether link status is enabled.

gateway

Specifies the gateway for this interface. This parameter is optional. If this parameter is not given, the interface has no gateway.

pciBusLocation

Specifies the PCI bus location of the RTX64-owned NIC for this interface in the form "bus;device;function", where bus, device, and function are each non-negative integers. If there is only one network interface configured to use the NIC driver specified in member Driver, this member can be set to "0;0;0" instead of the actual PCI bus location of the NIC. If multiple network interfaces are configured to use the same NIC driver, all of them must have the correct PCI bus location specified in this member. This NIC must be owned by RTX64, otherwise APIs that take this structure as input will fail.

interruptPriority

Specifies the interrupt priority for the interface. This must be a valid RTX64 priority, an integer in the range 0 to 127. This parameter is optional.

mtu

Specifies the Maximum Transmission Unit (MTU) size, in bytes, for the interface. This value must be within the range 1500 bytes to 9000 bytes. This parameter is optional. If not given, it defaults to the stack-wide MTU, which defaults to 1500.

ipv6Address

Specifies the IPv6 address. Parameter ipv6addr must be either a valid IPv6 address or the keyword auto, which means to enable IPv6 auto-configuration of the address and network prefix. This parameter is optional. If not given, the interface has no IPv6 address.

ipv6Prefix

Specifies the IPv6 network prefix. This parameter is optional. If not given, it defaults to 64.

receivePriority

Specifies the RT-TCP/IP stack's receive thread priority. This must be a valid RTX64 priority in the range 0 to 127. This parameter is optional. If not given, it defaults to 63.

interrupt

Specifies the type of interrupt that this interface uses. This parameter is optional. If not given, it defaults to InterruptType.MSIX.

numReceiveBuffers

Specifies the number of receive buffers used by the interface. The minimum value for this member is 64. The maximum value for this member is hardware dependent. This parameter is optional. If not given, it defaults to 64. See Device-Specific Interface Values for the device-specific defaults and value ranges for this property.

numTransmitBuffers

Specifies the number of transmit buffers used by the interface. The minimum value for this member is 64. The maximum value for this member is hardware dependent. This parameter is optional. If not given, it defaults to 64. See Device-Specific Interface Values for the device-specific defaults and value ranges for this property.

deviceInstanceID

Specifies the device Instance ID of the device used by the interface. This parameter is optional. If not given, it defaults to the empty string. The value of the parameter does not affect the behavior of this network interface in any way, but it tells the RTX64 Control Panel which device to associate with this network interface in the Control Panel GUI. Therefore, if this parameter is set to any non-empty string value, that value must specify the device Instance ID of a device that has been converted to RTX64. If this parameter is a non-empty string, its value must be unique among all RTX64 network interfaces, otherwise an exception will be thrown.

Return Value

Type: IConfigNetworkInterface
A reference to the newly created NetworkInterface object.

Remarks

You can add an interface with the same DeviceInstanceID as an existing interface as long as the existing interface is disabled. If you were to then enable the first interface, it may result in error code RT_ERROR_DEVICE_INSTANCE_ID_INVALID, which indicates there is already an enabled interface with the same DeviceInstanceID.

The same is true when adding an interface with the same PCIBusLocation as an existing interface, only this would result in error code RT_ERROR_PCI_BUS_LOCATION_INVALID when the other enabled interface with the same PCIBusLocation was detected.

Implements

CreateNetworkInterface(String, String, Bool, IPv4AddressNetMaskPair, NetworkInterface.SpeedDuplexType, String, UInt32, UInt32, Bool, String, String, UInt32, UInt32, String, UInt32, UInt32, NetworkInterface.InterruptType, UInt32, UInt32, UInt32, UInt32, UInt32, UInt32, UInt32, UInt32)

Exceptions

Exception	Condition
RTX64Exception	Throws an instance of RTX64Exception if an interface with the same name or PCI bus location already exists.

Reference

Network Class

CreateNetworkInterface Overload

IntervalZero.RTX64.Config Namespace