Difference between revisions of "Studio:Transport Configuration File"

From STRIDE Wiki
Jump to: navigation, search
(The '''Transport Properties''' section)
Line 39: Line 39:
  
 
=== The '''Transport Properties''' section ===
 
=== The '''Transport Properties''' section ===
Each of these sections contain property settings that are specific to a particular transport DLL. By default, two transports are provided for - settings for the '''Socket''' and '''Serial''' transports that are installed with STRIDE. If a custom transport is added, make sure that the appropriate transport property names and values are represented in a new section, with the section name matching the custom transport name. Refer to the [[http://www.s2technologies.com/pdf/s2sTransport.pdf Host Runtime Transport Specification]] document for more information on adding a custom transport DLL.
+
Each of these sections contain property settings that are specific to a particular transport DLL. By default, two transports are provided for - settings for the '''Socket''' and '''Serial''' transports that are installed with STRIDE. If a custom transport is added, make sure that the appropriate transport property names and values are represented in a new section, with the section name matching the custom transport name. Refer to the [http://www.s2technologies.com/pdf/s2sTransport.pdf Host Runtime Transport Specification] document for more information on adding a custom transport DLL.
  
 
[[Category:Reference]]
 
[[Category:Reference]]
 
[[Category:Configuration]]
 
[[Category:Configuration]]

Revision as of 09:35, 2 October 2008

The Transport configuration file contains default settings for the STRIDE Transport Server, an out-of-process COM server that manages connections between host and target processes, and also provides loopback and diagnostic features. The configuration file is located under the STRIDE installation directory, in the bin' folder, in the "transport.cfg" file. Users may edit this file to change configuration settings, but the file must not be moved or renamed.

Prerequisites

The Config::IniFiles package must be installed for perl scripts to read this formatted file. If using an ActiveState perl distribution, the command 'ppm install config-inifiles' will insure that it is installed.

Sample configuration file

 ;
 ; Configuration file for STRIDE Unit runner (TestUnitRun.pl)
 ; (standard INI/CFG file format)
 ;
 [General]
   ActiveTransport = Sockets (S2)
 [Keep Alive]
   Active = yes
   Interval = 3000
   RetryCount = 2
   Timeout = 2000
 [Sockets (S2)]
   DeviceAddress = localhost
   DevicePort = 8000
 [Serial (S2)]
   SerialPort = COM2
   BaudRate = 57600
   DataBits = 8
   StopBits = 1
   Parity = none

The General section

  • The value of the ActiveTransport property should match a name provided by a transport DLL located in the default directory for transport DLLs, the "transports" folder under the STRIDE installation directory. This value should also match a Transport Properties section in the configuration file, described below.

The Keep Alive section

  • The Active property enables or disables the Runtime ping messages that get sent to the Target.
  • The Interval property sets the time interval in milliseconds between pings.
  • The RetryCount property sets the allowable number of ping failures. Once this number is exceeded, the connection to the target will be automatically closed.
  • The Timeoutproperty sets the ping timeout value in milliseconds. This controls the time that the Transport Server waits for a response to a ping message. If a response is not received within this time, it is considered a ping failure; once the number of ping failures specified in the Retry Count field is exceeded, the connection to the target is closed.

The Transport Properties section

Each of these sections contain property settings that are specific to a particular transport DLL. By default, two transports are provided for - settings for the Socket and Serial transports that are installed with STRIDE. If a custom transport is added, make sure that the appropriate transport property names and values are represented in a new section, with the section name matching the custom transport name. Refer to the Host Runtime Transport Specification document for more information on adding a custom transport DLL.