Component Class

This class encapsulates various TCP/IP configuration operations.

Namespace:  IntervalZero.MaxRT.Tcpip.Config
Assembly:  IntervalZero.MaxRT.Tcpip.Config (in IntervalZero.MaxRT.Tcpip.Config.dll) Version: 1.0.0.0 (File version: 1.0.1)

Syntax

Copy
public class Component : wRTOSObject, ITCPIPComponent

 

The Component type exposes the following members:

Methods

 

Name Description

Public method

IsLicensed

Queries the license status of the TCP/IP Stack component.

Public method

ResetAll

Resets all TCP/IP component configurations to their default values.

Public method

ResetAutoStart

Resets the AutoStart parameter to its default of manual start, a value of zero (0). After calling this method, the TCP/IP Stack must be restarted for the changes to take effect.

Public method

ResetExtMSpacePoolMinimumSize

Resets the ExtMSpacePoolMinimumSize property to its default value of 6,272 KB. After calling this method, the TCP/IP Stack must be restarted for the changes to take effect.

Public 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 TCP/IP Stack must be restarted for the changes to take effect.

Public method

ResetIPReassemblyTimeout

Resets the IPReassemblyTimeout property to its default value of 60 seconds. After calling this method, the TCP/IP Stack must be restarted for the changes to take effect.

Public method

ResetMaxArpEntries

Resets the MaxArpEntries property to its default value of 256 entries. After calling this method, the TCP/IP Stack must be restarted for the changes to take effect.

Public method

ResetMaxConcurrency

Resets the MaxConcurrency property to its default value of zero (0), allowing the Stack to determine a good MaxConcurrency value and use it. After calling this method, the TCP/IP Stack must be restarted for the changes to take effect.

Public method

ResetMaxSockets

Resets the MaxSockets property to its default value of 64 sockets. After calling this method, the TCP/IP Stack must be restarted for the changes to take effect.

Public method

ResetMemory

Resets the Memory property to its default value of 1024 KB. After calling this method, the TCP/IP Stack must be restarted for the changes to take effect.

Public method

ResetMSpacePoolExpandable

Resets the MSpacePoolExpandable property to its default of enabled, which is a value of 1. After calling this method, the TCP/IP Stack must be restarted for the changes to take effect.

Public method

ResetMSpacePoolExpandSize

Resets the MSpacePoolExpandSize property to its default value of 1024 KB. After calling this method, the TCP/IP Stack must be restarted for the changes to take effect.

Public method

ResetTimerExecutePriority

Resets the TimerExecutePriority property to its default priority of 66. After calling this method, the TCP/IP Stack must be restarted for the changes to take effect.

Public method

ResetTimerIdealProcessor

Resets the TimerIdealProcessor property to its default value of 0xFFFFFFFF, indicating that the timer should use the same processor as the main thread. After calling this method, the TCP/IP Stack must be restarted for the changes to take effect.

Public method

ResetTimerInterval

Resets the TimerInterval property to its default value of 100 milliseconds. After calling this method, the TCP/IP Stack must be restarted for the changes to take effect.

Public method

ResetTimerPriority

Resets the TimerPriority property to its default priority of 66. After calling this method, the TCP/IP Stack must be restarted for the changes to take effect.

Public method

ResetVerbose

Resets the Verbose property to its default of disabled, which is a value of zero (0). After calling this method, the TCP/IP Stack must be restarted for the changes to take effect.

Properties

  Name Description

AutoStart

Gets or sets a Boolean indicating whether the TCP/IP Stack component should start automatically.

ExtMSpacePoolMinimumSize

Gets or sets the minimum size of the TCP/IP Stack's external memory space pool.

IdealProcessor

Gets or sets the TCP/IP Stack's ideal processor. 0xFFFFFFFF is used for the first available core.

Interfaces

Gets a list of NetworkInterface objects representing the network interfaces enabled for TCP/IP.

IPReassemblyTimeout

Gets or sets the IP reassembly timeout value.

MaxArpEntries

Gets or sets the maximum number of ARP entries.

MaxConcurrency

Gets or sets the maximum concurrency level.

MaxSockets

Gets or sets the maximum number of sockets.

Memory

Gets or sets the TCP/IP Stack’s memory allocation.

MSpacePoolExpandable

Gets or sets a Boolean indicating whether the memory space pool is expandable.

MSpacePoolExpandSize

Gets or sets the size by which the memory space pool can expand.

RestartNeeded

Indicates whether the TCP/IP Stack needs to be restarted for configuration changes made with this class to take effect.

TimerExecutePriority

Gets or sets the execution priority of the TCP/IP Stack's timer thread.

TimerIdealProcessor

Gets or sets the ideal processor for the TCP/IP Stack's timer thread.

TimerInterval

Gets or sets the timer interval used by the TCP/IP Stack.

TimerPriority

Gets or sets the timer priority used by the TCP/IP Stack.

Verbose

Gets or sets a Boolean indicating whether verbose logging is enabled.

See Also: