org.virtualbox_4_1
Class ISerialPort

java.lang.Object
  extended by org.virtualbox_4_1.IUnknown
      extended by org.virtualbox_4_1.ISerialPort

public class ISerialPort
extends IUnknown

The ISerialPort interface represents the virtual serial port device. The virtual serial port device acts like an ordinary serial port inside the virtual machine. This device communicates to the real serial port hardware in one of two modes: host pipe or host device. In host pipe mode, the #path attribute specifies the path to the pipe on the host computer that represents a serial port. The #server attribute determines if this pipe is created by the virtual machine process at machine startup or it must already exist before starting machine execution. In host device mode, the #path attribute specifies the name of the serial port device on the host computer. There is also a third communication mode: the disconnected mode. In this mode, the guest OS running inside the virtual machine will be able to detect the serial port, but all port write operations will be discarded and all port read operations will return no data.

See Also:
Interface ID: {937F6970-5103-4745-B78E-D28DCF1479A8}

Field Summary
 
Fields inherited from class org.virtualbox_4_1.IUnknown
obj, port
 
Constructor Summary
ISerialPort(java.lang.String wrapped, org.virtualbox_4_1.jaxws.VboxPortType port)
           
 
Method Summary
 java.lang.Boolean getEnabled()
          Flag whether the serial port is enabled.
 PortMode getHostMode()
          How is this port connected to the host.
 java.lang.Long getIOBase()
          Base I/O address of the serial port.
 java.lang.Long getIRQ()
          IRQ number of the serial port.
 java.lang.String getPath()
          Path to the serial port's pipe on the host when getHostMode() is PortMode_HostPipe, or the host serial device name when getHostMode() is PortMode_HostDevice.
 java.lang.Boolean getServer()
          Flag whether this serial port acts as a server (creates a new pipe on the host) or as a client (uses the existing pipe).
 java.lang.Long getSlot()
          Slot number this serial port is plugged into.
static ISerialPort queryInterface(IUnknown obj)
           
 void setEnabled(java.lang.Boolean value)
          Flag whether the serial port is enabled.
 void setHostMode(PortMode value)
          How is this port connected to the host.
 void setIOBase(java.lang.Long value)
          Base I/O address of the serial port.
 void setIRQ(java.lang.Long value)
          IRQ number of the serial port.
 void setPath(java.lang.String value)
          Path to the serial port's pipe on the host when getHostMode() is PortMode_HostPipe, or the host serial device name when getHostMode() is PortMode_HostDevice.
 void setServer(java.lang.Boolean value)
          Flag whether this serial port acts as a server (creates a new pipe on the host) or as a client (uses the existing pipe).
 
Methods inherited from class org.virtualbox_4_1.IUnknown
getRemoteWSPort, getWrapped, releaseRemote
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ISerialPort

public ISerialPort(java.lang.String wrapped,
                   org.virtualbox_4_1.jaxws.VboxPortType port)
Method Detail

getSlot

public java.lang.Long getSlot()
Slot number this serial port is plugged into. Corresponds to the value you pass to IMachine.getSerialPort(Long) to obtain this instance.

Returns:
Long

getEnabled

public java.lang.Boolean getEnabled()
Flag whether the serial port is enabled. If disabled, the serial port will not be reported to the guest OS.

Returns:
Boolean

setEnabled

public void setEnabled(java.lang.Boolean value)
Flag whether the serial port is enabled. If disabled, the serial port will not be reported to the guest OS.

Parameters:
value - Boolean

getIOBase

public java.lang.Long getIOBase()
Base I/O address of the serial port.

Returns:
Long

setIOBase

public void setIOBase(java.lang.Long value)
Base I/O address of the serial port.

Parameters:
value - Long

getIRQ

public java.lang.Long getIRQ()
IRQ number of the serial port.

Returns:
Long

setIRQ

public void setIRQ(java.lang.Long value)
IRQ number of the serial port.

Parameters:
value - Long

getHostMode

public PortMode getHostMode()
How is this port connected to the host. NOTE: Changing this attribute may fail if the conditions for getPath() are not met.

Returns:
org.virtualbox_4_1.PortMode

setHostMode

public void setHostMode(PortMode value)
How is this port connected to the host. NOTE: Changing this attribute may fail if the conditions for getPath() are not met.

Parameters:
value - org.virtualbox_4_1.PortMode

getServer

public java.lang.Boolean getServer()
Flag whether this serial port acts as a server (creates a new pipe on the host) or as a client (uses the existing pipe). This attribute is used only when getHostMode() is PortMode_HostPipe.

Returns:
Boolean

setServer

public void setServer(java.lang.Boolean value)
Flag whether this serial port acts as a server (creates a new pipe on the host) or as a client (uses the existing pipe). This attribute is used only when getHostMode() is PortMode_HostPipe.

Parameters:
value - Boolean

getPath

public java.lang.String getPath()
Path to the serial port's pipe on the host when getHostMode() is PortMode_HostPipe, or the host serial device name when getHostMode() is PortMode_HostDevice. For both cases, setting a null or empty string as the attribute's value is an error. Otherwise, the value of this property is ignored.

Returns:
String

setPath

public void setPath(java.lang.String value)
Path to the serial port's pipe on the host when getHostMode() is PortMode_HostPipe, or the host serial device name when getHostMode() is PortMode_HostDevice. For both cases, setting a null or empty string as the attribute's value is an error. Otherwise, the value of this property is ignored.

Parameters:
value - String

queryInterface

public static ISerialPort queryInterface(IUnknown obj)