Data Object - VirtualSerialPortPipeBackingInfo

Extends
VirtualDevicePipeBackingInfo

Data Object Description

This data object type provides information for backing a virtual serial port with a pipe. A pipe enables you to set up the virtual serial port to connect to an application on the host computer. This is useful, for example, if you want to use an application on the host to capture debugging information sent from the virtual machine's serial port.

Properties

Name Type Description
endpointxsd:string This defines the type of endpoint used for this side of the pipe backing. Valid values are client or server.
noRxLoss*xsd:boolean When devices are backed with a pipe, this feature attempts to optimize data transfer by using the "no receive loss" option. If the option is supported (as determined in the VirtualSerialPortOptionPipeBackingOption data object type), then there is no data loss when data is received from the application.

Setting this flag is optional. This flag indicates whether or not "no receive loss" is enabled ("true") or disabled ("false"). Using this flag depends on whether or not "no receive loss" is supported as designated by the setting of the boolean noRxLoss.supported property in the VirtualSerialPortOption data object type.

  • If noRxLoss.supported is set to "false": the boolean noRxLoss flag is ignored.
  • If noRxLoss.supported is set to "true": the boolean noRxLoss can be set to "true", "false", or not set. If the boolean is not set, then its value will be taken from the setting of noRxLoss.defaultValue property in the VirtualSerialPortOption data object type.
Properties inherited from VirtualDevicePipeBackingInfo
pipeName
Properties inherited from VirtualDeviceBackingInfo
None
Properties inherited from DynamicData
dynamicProperty, dynamicType
*Need not be set
Show WSDL type definition