Subsystem Class

This class encapsulates various control operations for the RTX64 real-time Subsystem.
Inheritance Hierarchy
SystemObject
  IntervalZero.RTX64RTX64Object
    IntervalZero.RTX64.ControlSubsystem

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

Syntax
public class Subsystem : RTX64Object, IControlSubsystem

The Subsystem type exposes the following members.

Constructors
NameDescription
Public methodSubsystem Constructor.
Top
Properties
NameDescription
Public propertyCreationTime Date and time the object was created. (Inherited from RTX64Object.)
Public propertyExtendedStatus Returns an extended status as a human-readable string.
Protected propertyIsDisposed True if the object has been disposed, false otherwise. (Inherited from RTX64Object.)
Public propertyName Name of the object. (Inherited from RTX64Object.)
Public propertyState Read-only. Returns the current state of the Subsystem. Please see the documentation for enumerator SubsystemState.ERROR.
Public propertyStateEx Returns the current state of the Subsystem without waiting to lock the Subsystem start/stop mutex.
Top
Methods
NameDescription
Public methodDispose Dispose method. (Inherited from RTX64Object.)
Protected methodOnNotifyPropertyChanged Called when a property is changed (Inherited from RTX64Object.)
Public methodGetNALStatusQueries the status of the Network Abstraction Layer (NAL).
Public methodGetNetworkInterfacesStatusQueries the status of each enabled network interface.
Public methodGetTCPIPStatusQueries the status of the RT-TCP/IP Stack.
Public methodStart Starts the Subsystem. If the Subsystem fails to start properly, this method throws an exception of type RTX64Exception, and instance property State returns START_ERROR. If the RT-TCP/IP stack is set to run on RTX64 start and its license is not valid throws RTX64InvalidTcpIpStackLicense exception.
Public methodStartNAL Starts the Network Abstraction Layer if it is running.
Public methodStartTcpipStack Starts the RT-TCP/IP Stack. If there is no valid license for the RTX64 TCP/IP stack (license feature name "TCP64"), an exception is thrown and the stack is not started.
Public methodStop Stops the Subsystem. If the Subsystem fails to stop properly, this method throws an exception of type RTX64Exception, and instance property State returns STOP_ERROR.
Public methodStopForceStops the Subsystem even if RTSS processes or Windows processes linked to RTX64 are still running. If the Subsystem fails to stop properly, this method throws an exception of type RTX64Exception, and instance property State returns STOP_ERROR.
Public methodStopNAL Stops the Network Abstraction Layer if it is running.
Public methodStopTcpipStack Stops the RT-TCP/IP stack if it is running. This method behaves the same as passing 0 to StopTcpipStack(uint timeoutInSeconds). See that method's documentation for timeout behavior.
Public methodStopTcpipStack(UInt32) Stops the RT-TCP/IP stack if it is running. Specifies the number of seconds that this method should wait for the RT-TCP/IP stack to stop. This parameter is optional and defaults to 0, which means wait 30 seconds plus an additional 10 seconds for each configured network interface (other than the RTX64 Virtual Network interface).
Top
Events
NameDescription
Public eventPropertyChanged Event Fired when a property value is changed (Inherited from RTX64Object.)
Top
See Also