|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.virtualbox_6_1.IUnknown
org.virtualbox_6_1.ISerialPort
public class ISerialPort
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.
Interface ID: {5587D0F6-A227-4F23-8278-2F675EEA1BB2}
Field Summary |
---|
Fields inherited from class org.virtualbox_6_1.IUnknown |
---|
obj, objMgr, port |
Constructor Summary | |
---|---|
ISerialPort(java.lang.String wrapped,
org.virtualbox_6_1.ObjectRefManager objMgr,
org.virtualbox_6_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, the host serial device name whengetHostMode() is PortMode_HostDevice or the TCPport(server) orhostname:port(client) whengetHostMode() is PortMode_TCP. |
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. |
UartType |
getUartType()
Selects the emulated UART implementation. |
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, the host serial device name whengetHostMode() is PortMode_HostDevice or the TCPport(server) orhostname:port(client) whengetHostMode() is PortMode_TCP. |
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). |
void |
setUartType(UartType value)
Selects the emulated UART implementation. |
Methods inherited from class org.virtualbox_6_1.IUnknown |
---|
getObjMgr, getRemoteWSPort, getWrapped, releaseRemote |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ISerialPort(java.lang.String wrapped, org.virtualbox_6_1.ObjectRefManager objMgr, org.virtualbox_6_1.jaxws.VboxPortType port)
Method Detail |
---|
public java.lang.Long getSlot()
IMachine.getSerialPort(Long)
to obtain this instance.
public java.lang.Boolean getEnabled()
public void setEnabled(java.lang.Boolean value)
value
- Booleanpublic java.lang.Long getIOBase()
public void setIOBase(java.lang.Long value)
value
- Longpublic java.lang.Long getIRQ()
public void setIRQ(java.lang.Long value)
value
- Longpublic PortMode getHostMode()
getPath()
are not met.
public void setHostMode(PortMode value)
getPath()
are not met.
value
- org.virtualbox_6_1.PortModepublic java.lang.Boolean getServer()
getHostMode()
is PortMode_HostPipe or PortMode_TCP.
public void setServer(java.lang.Boolean value)
getHostMode()
is PortMode_HostPipe or PortMode_TCP.
value
- Booleanpublic java.lang.String getPath()
getHostMode()
is
PortMode_HostPipe, the host serial device name whengetHostMode()
is PortMode_HostDevice or the TCPport(server) orhostname:port(client) whengetHostMode()
is PortMode_TCP.
For those cases, setting a null or empty string as the attribute's
value is an error. Otherwise, the value of this property is ignored.
public void setPath(java.lang.String value)
getHostMode()
is
PortMode_HostPipe, the host serial device name whengetHostMode()
is PortMode_HostDevice or the TCPport(server) orhostname:port(client) whengetHostMode()
is PortMode_TCP.
For those cases, setting a null or empty string as the attribute's
value is an error. Otherwise, the value of this property is ignored.
value
- Stringpublic UartType getUartType()
public void setUartType(UartType value)
value
- org.virtualbox_6_1.UartTypepublic static ISerialPort queryInterface(IUnknown obj)
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |