ServerConsole Class
This class reads and modifies the configuration of the wRTOS Server Console. Assignments to properties on an instance of this class modify Registry values that contain the persistent state of the configuration of the Server Console. After changing the configuration of the Server Console using this class, the Server Console must be restarted for those changes to take effect.
Inheritance Hierarchy
System.Object
IntervalZero.MaxRT.wRTOS.wRTOSObject
IntervalZero.MaxRT.wRTOS.Config.ServerConsole
Namespace:
IntervalZero.MaxRT.wRTOS.Config
Assembly:
IntervalZero.MaxRT.wRTOS (in IntervalZero.MaxRT.wRTOS.dll) Version: 1.0.0.0 (File version: 1.0.1)
Syntax
public class ServerConsole : wRTOSObject,
IConfigServerConsole
The ServerConsole class exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
|
|
Constructor. |
Properties
| Name | Description | |
|---|---|---|
|
|
Gets/sets whether real-time application consoles close automatically. If true, the consoles close automatically, otherwise they remain open until the user closes them. When configured to close automatically, and if property UsePerProcessConsoles is true, each console closes when its corresponding real-time process terminates. When UsePerProcessConsoles is false, the single console closes when the Subsystem stops. |
|
|
|
Gets or sets the screen buffer size (in kilobytes) of real-time application consoles. If console output exceeds this limit, the oldest text in the console window is deleted. |
|
|
|
This property controls whether real-time application console display program output. If set to true, program output is displayed, otherwise it is not displayed. Logging of program output is configured independently from this configuration setting (see property LogDataToFile). |
|
|
|
True if the object has been disposed, false otherwise. (Inherited from wRTOSObject.) |
|
|
|
This property controls whether real-time application consoles log program output to a log file. |
|
|
|
This property gets/sets the pathname of the folder where real-time application console log files are written. If this pathname doesn't exist, an exception is thrown. |
|
|
|
This property gets/sets the maximum size of the real-time application console log folder, in megabytes. The minimum valid value is 1 MB. The maximum valid value is uint.MaxValue MB. |
|
|
|
If this property is true, real-time application consoles start minimized, otherwise it doesn't. |
|
|
|
This property gets/sets the TCP port number on which wRTOS Server listens for real-time application console connections. The minimum valid value is 1. The maximum valid value is 65535. |
|
|
|
This property gets/sets whether or not each real-time process displays output in its own real-time application console. If true, per-process consoles are used, otherwise only one console shows output from all real-time processes. |
Methods
| Name | Description | |
|---|---|---|
|
|
Dispose method. (Inherited from wRTOSObject.) |
|
|
|
Called when a property is changed (Inherited from wRTOSObject.) |
|
|
|
Resets all ServerConsole properties to their default values |
|
|
|
Resets property AutoClose to its default value. |
|
|
|
Resets property DisplayBufferSize to its default value (64). |
|
|
|
Resets property DisplayUserInterface to its default value (true). |
|
|
|
Resets property LogDataToFile to its default value (false). |
|
|
|
Resets property LogFolder to its default value. |
|
|
|
Resets property LogFolderDiskSize to its default value. |
|
|
|
Resets property StartMinimized to its default value (false). |
|
|
|
Resets property TCPPort to its default value. |
|
|
|
Resets property UsePerProcessConsoles to its default value. |
Events
| Name | Description | |
|---|---|---|
|
|
Event Fired when a property value is changed (Inherited from wRTOSObject.) |
See Also:
