VirtualSerialPortPipeBackingOption

The VirtualSerialPortPipeBackingOption data object contains the options for backing a serial port device with a pipe to another process.

AllOf

This class requires all of the following:

VirtualDevicePipeBackingOption

JSON Example

{
    "_typeName": "string",
    "type": "string",
    "endpoint": {
        "_typeName": "string",
        "valueIsReadonly": false,
        "choiceInfo": [
            {
                "_typeName": "string",
                "label": "string",
                "summary": "string",
                "key": "string"
            }
        ],
        "defaultIndex": 0
    },
    "noRxLoss": {
        "_typeName": "string",
        "valueIsReadonly": false,
        "supported": false,
        "defaultValue": false
    }
}

endpoint

Required

Indicates the choices available and the default setting for the pipe endpoint.

As an endpoint, the virtual machine can act as a client or a server.

noRxLoss

Required

Indicates whether the server supports optimized data transfer over the pipe and also specifies default behavior.

When this feature is supported and enabled, the server buffers data to prevent data overrun. This allows the virtual machine to read all of the data transferred over the pipe with no data loss.

If optimized data transfer is supported (noRxLoss.supported is true):

You can enable (or disable) the feature explicitly by setting the noRxLoss property on the pipe backing information object.
If you do not set the noRxLoss property on the the pipe backing information object, the server enables optimized data transfer if the noRxLoss.defaultValue property on the pipe backing options object is true.

If noRxLoss.supported is false, the server ignores the optimization settings.

Note: You can use this feature even if the other end of the pipe is not an application, but it is more likely to fail.

Property Of

ArrayOfVirtualSerialPortPipeBackingOption