Driver Diagnostic tools

The VTS driver module contains a traffic monitor API, allowing the driver communications stream to be viewed or logged by viewer applications.  The interface is accessed through the TMObj variable within the scope of the “Driver” Object value.  Traffic must be manually reported by the driver tag using:

 

Format:                 Driver\TMObj\ReportTraffic(PortName, Direction, TrafficData);

 

Parameters:          PortName    This should be set to a text string identifying the port tag used by the driver.

                             Direction      Specifies the direction of the traffic (0 = Receive, 1 = Transmit).

                             TrafficData Text string used to display the actual contents of the communications data.  This string will be displayed as is and should be formatted into a legible string before being passed to the ReportTraffic Module.

 

The “Active” flag located within the scope of TMObj indicates whether any listener applications are monitoring the driver.  ReportTraffic should only be executed if the “Active” flag is set.

IfThen(Driver\TMObj\Active,

  Driver\TMObj\ReportTraffic(ExternalPort\Name, Direction, Data);

);

Topics in this section:

Statistics Logging