metaonly module xdc.rov.testserver.Main

Command implementation

The DSlite port must be known at the time the server is started. Therefore, when starting CCS, the environment variable TI_DS_WEBSOCKET_PORT must be set and that same port number must be supplied to xdc.rov.testserver. [ more ... ]
Configuration settings sourced in xdc/rov/testserver/Main.xdc
var Main = xdc.useModule('xdc.rov.testserver.Main');
module-wide config parameters
        ' ',
        'Usage',
        '[--exec <executable>]',
        '[--port <DSLite Websocket port>]',
        '[-v <debug level>]',
        '[--help]',
        ' '
    ];
module-wide functions
    Main.exec// xs script entry point(Any args) returns Any
    Main.main// xs shell entry point(Any args) returns Any
per-instance config parameters
    var params = new Main.Params// Instance config-params object;
        params.executable// Executable to run ROV on = String "";
        params.port// DSLite port = UInt undefined;
        params.verbose// Defines the amount of debug info = UInt 0;
per-instance functions
    inst.run// Underlying implementation of the command(Cmdr.Instance cmdr, String[] args) returns Any
 
DETAILS
The DSlite port must be known at the time the server is started. Therefore, when starting CCS, the environment variable TI_DS_WEBSOCKET_PORT must be set and that same port number must be supplied to xdc.rov.testserver.
Commands:
Start the server - xs xdc.rov.testserver --exec <full path> --port <port_number>
Get a list of Modules and Tabs l
Get a Module's View v Module View
Issue the command "Run" to the debugger r
Issue the command "Pause" to the debugger p
Exit xdc.rov.testserver e
 
config Main.usage  // module-wide

Usage for this command

Configuration settings
Main.usage = String[] [
    ' ',
    'Usage',
    '[--exec <executable>]',
    '[--port <DSLite Websocket port>]',
    '[-v <debug level>]',
    '[--help]',
    ' '
];
 
 
Main.exec()  // module-wide

xs script entry point

Configuration settings
Main.exec(Any args) returns Any
 
DETAILS
This function is called from within other XDCscript scripts and performs the same operations as main() except that, rather than output the return value of inst.run(), this value is simply returned to the caller of exec().
 
Main.main()  // module-wide

xs shell entry point

Configuration settings
Main.main(Any args) returns Any
 
DETAILS
This function
  • creates a no-arg instance, inst, of the module inheriting this interface;
  • parses command line arguments placing all options in the config params of the inheriting module;
  • creates a xdc.tools.Cmdr instance, cmdr;
  • calls inst.run() with the cmdr and any command line command line arguments not parsed as options; and
  • outputs the return result from inst.run()
Instance Config Parameters

Configuration settings
var params = new Main.Params;
// Instance config-params object
    params.executable = String "";
    // Executable to run ROV on
    params.port = UInt undefined;
    // DSLite port
    params.verbose = UInt 0;
    // Defines the amount of debug info
 
config Main.Params.executable  // instance

Executable to run ROV on

Configuration settings
var params = new Main.Params;
  ...
params.executable = String "";
 
 
config Main.Params.port  // instance

DSLite port

Configuration settings
var params = new Main.Params;
  ...
params.port = UInt undefined;
 
DETAILS
Corresponds to the value in the environment variable TI_DS_WEBSOCKET_PORT. The variable must be set at the time CCS is started.
 
config Main.Params.verbose  // instance

Defines the amount of debug info

Configuration settings
var params = new Main.Params;
  ...
params.verbose = UInt 0;
 
 
Main.run()  // instance

Underlying implementation of the command

Configuration settings
inst.run(Cmdr.Instance cmdr, String[] args) returns Any
 
DETAILS
Since this method is used to support both command line tools and other XDCscript scripts, it is important to avoid explicit termination of the JVM via java.lang.System.exit(); doing so precludes callers from handling failures.
Implementations should instead call
generated on Fri, 22 Feb 2019 01:33:21 GMT