Files
deb-python-pyvmomi/docs/vim/vm/device/VirtualSerialPortOption/PipeBackingOption.rst
Shawn Hartsock 15f7be9a52 pyVmomi reStructured Text Documentation
This external documentation for pyVmomi was generated using Googly Docs
(aka Google Standard Documentation) which renders very cleanly in
GitHub. Internal documentation for a class should be done in Sphinx
format because tools like pyCharm and Eclipse can use that documentation
as a hint for code completion.

Note: External docs as Googly Docs, internal docs as Sphinx.

Closes bug#15
2014-06-17 14:07:42 -04:00

2.1 KiB

vim.vm.device.VirtualSerialPortOption.PipeBackingOption

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

extends

vim.vm.device.VirtualDeviceOption.PipeBackingOption

Attributes:

endpoint (vim.option.ChoiceOption):

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 (vim.option.BoolOption):

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.supportedistrue):
  • 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.