IntervalZero RTX64 Managed Code Framework

TCPIP Class

This class represents a single TCP/IP instance.

Inheritance Hierarchy

System.Object
IntervalZero.RTX64RTX64Object
IntervalZero.RTX64.ConfigTCPIP

Namespace: IntervalZero.RTX64.Config
Assembly: IntervalZero.RTX64 (in IntervalZero.RTX64.dll) Version: 3.3.0.0 (File version: 3.5.0)

Syntax

C++

Copy

public class TCPIP : RTX64Object, IConfigTCPIP

Public Class TCPIP
	Inherits RTX64Object
	Implements IConfigTCPIP

public ref class TCPIP : public RTX64Object, 
	IConfigTCPIP

type TCPIP =  
    class
        inherit RTX64Object
        interface IConfigTCPIP
    end

Properties

	Name	Description
	IsDisposed	True if the object has been disposed, false otherwise. (Inherited from RTX64Object.)
	IpReassemblyTimeout	Specifies the timeout (in seconds) for the stack to reassemble a fragmented IP packet.
	MaxArpEntries	Read/write. Accesses the maximum number of ARP entries that the RT-TCP/IP stack will allow. The specified value must be greater than 0. After changing this property, the real-time TCP/IP stack must be restarted for the changes to take effect.
	MaxConcurrency	The number of threads that are allowed to run concurrently within the TCP/IP stack. The TCP/IP Stack needs to initialize certain attributes on when started to allow a certain number of threads to run and provide services for each client that requests services from the TCP/IP stack. For example, running a client and a server application will require 1 concurrency each. The TCP/IP Stack running by itself requires 1 concurrency to run the Loopback service. Loading and managing interfaces requires an average of 3 threads, thus a concurrency of 3 for each interface. NOTE: We recommend that this value be calculated automatically (default). NOTE: If the TCP/IP Stack requires more threads than the initialization process prepared for, the Stack will crash.
	MaxSockets	Read/write. Accesses the maximum number of sockets that the RT-TCP/IP stack will provide. The specified value must be in the range 1 to 32765. After changing this property, the RT-TCP/IP stack must be restarted for the changes to take effect.
	Memory	Read/write. Accesses the configuration parameter that specifies the memory to be allocated for all RTX64 network stacks. This value is in kilobyte units. Even though this is an instance property, assigning a value to this property affects all stacks, not just the specific stack on which the property referenced. This is an instance property so that COM clients can access it. After changing this property, the RT-TCP/IP stack must be restarted for the changes to take effect.
	RestartNeeded	Read-only. This property is true if this TCP/IP stack needs to be restarted in order for configuration changes made to this stack to take effect, even if the changes were made in another process. It is false, otherwise.
	Started	Read-only. Returns true if this instance of the RT-TCP/IP Stack is started, false if it is not.
	StartWithNAL	Returns TRUE if the RT-TCP/IP Stack should start when the NAL starts. Returns FALSE if the RT-TCP/IP Stack does not start with the NAL.
	TickInterval	Read/write. Accesses the RT-TCP/IP stack's tick interval in milliseconds. After changing this property, this RT-TCP/IP stack must be restarted for the changes to take effect.
	TimerIdealProcessor	Display or modify the timer thread ideal processor of the RT-TCP/IP stack. This is a non-negative integer that specifies an RTSS processor. If this property is set to zero, it refers to the same RTSS processor that is configured via property IdealProcessor, which is not necessarily the first RTSS processor. 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.
	TimerPriority	Display or modify the RT-TCP/IP stack's timer priority. The specified value must be a valid RTSS priority in the range 0 to 127, where 0 is the lowest priority and 127 is the highest priority. After changing this property, the RT-TCP/IP stack must be restarted for the changes to take effect.

Top

Methods

	Name	Description
	Reset	Resets all RT-TCP/IP stack configuration parameters to their default values. After calling this method, the RT-TCP/IP stack must be restarted for the changes to take effect.
	ResetAutoStart	Resets AutoStart of the RT-TCP/IP Stack to it's default value of true;
	ResetIdealProcessor	Resets property ResetIdealProcessor to its default value (0). After calling this method, the real-time TCP/IP stack must be restarted for the changes to take effect.
	ResetIpReassemblyTimeout	Resets property IpFragmentTimeout to its default value (64). After calling this method, the RT-TCP/IP stack must be restarted for the changes to take effect.
	ResetMaxArpEntries	Resets property MaxArpEntries to its default value (256). After calling this method, the real-time TCP/IP stack must be restarted for the changes to take effect.
	ResetMaxConcurrency	Resets property MaxConcurrency to its default value (Calculate automatically). After calling this method, the real-time TCP/IP stack must be restarted for the changes to take effect.
	ResetMaxSockets	Resets property ResetMaxSockets to its default value (64). After calling this method, the RT-TCP/IP stack must be restarted for the changes to take effect.
	ResetMemory	Resets property Memory to its default value (1024 KB). After calling this method, the RT-TCP/IP stack must be restarted for the changes to take effect.
	ResetStarted	Resets property Started to its default value. After calling this method, the real-time TCP/IP stack must be restarted for the changes to take effect.
	ResetStartWithNAL	Resets property StartWithNAL to its default value. After calling this method, the real-time TCP/IP stack must be restarted for the changes to take effect.
	ResetTickInterval	Resets property ResetTickInterval to its default value (100). After calling this method, the RT- TCP/IP stack must be restarted for the changes to take effect.
	ResetTimerIdealProcessor	Resets property ResetTimerIdealProcessor to its default value (0). After calling this method, the real-time TCP/IP stack must be restarted for the changes to take effect.
	ResetTimerPriority	Resets property ResetTimerPriority to its default value (66). After calling this method, the RT-TCP/IP stack must be restarted for the changes to take effect.
	SetInstanceId	Sets the instance ID of this Network object to be parameter instanceId. Currently, this can only be set to 0.

Top

Events

	Name	Description
	PropertyChanged	Event Fired when a property value is changed (Inherited from RTX64Object.)

Top

Reference

IntervalZero.RTX64.Config Namespace