Skip navigation links
B C D F G I L M O P R S V W X 

B

baudRate - Variable in class com.moxa.mxnportapi.MxNPort.IoctlMode
Actual baud rate.
break_error - Variable in class com.moxa.mxnportapi.MxNPort.LineError
Available constants: LINE_NO_ERROR, LINE_ERROR.

C

close() - Method in interface com.moxa.mxnportapi.MxNPort
Disable a serial port so that it cannot receive/transmit data.
com.moxa.mxnportapi - package com.moxa.mxnportapi
 
CTS - Variable in class com.moxa.mxnportapi.MxNPort.ModemStatus
Available constants: CTS_ON, CTS_OFF.
CTS_FLOW_ENABLE - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines CTS hardware flow control
CTS_OFF - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines CTS state OFF
CTS_ON - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines CTS state ON

D

DATA_BITS_5 - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines serial communication with 5 data bits
DATA_BITS_6 - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines serial communication with 6 data bits
DATA_BITS_7 - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines serial communication with 7 data bits
DATA_BITS_8 - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines serial communication with 8 data bits
dataBits - Variable in class com.moxa.mxnportapi.MxNPort.IoctlMode
DCD - Variable in class com.moxa.mxnportapi.MxNPort.ModemStatus
Available constants: DCD_ON, DCD_OFF.
DCD_OFF - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines DCD state OFF
DCD_ON - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines DCD state ON
DSR - Variable in class com.moxa.mxnportapi.MxNPort.ModemStatus
Available constants: DSR_ON, DSR_OFF.
DSR_FLOW_ENABLE - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines DSR hardware flow control
DSR_OFF - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines DSR state OFF
DSR_ON - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines DSR state ON
DTR_FLOW_ENABLE - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines DTR hardware flow control
DTR_OFF - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines DTS state OFF
DTR_ON - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines DTS state ON
DtrDsr - Variable in class com.moxa.mxnportapi.MxNPort.FlowCtrl
DTRDSR_FLOW_ENABLE - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines DTR/DSR software flow control
DTRDSR_FLOW_MASK - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines the bit mask of DTR/DSR hardware flow control

F

FlowCtrl() - Constructor for class com.moxa.mxnportapi.MxNPort.FlowCtrl
Constructor of FlowCtrl, initial the serial flow control settings by default values.
FlowCtrl(int, int, int) - Constructor for class com.moxa.mxnportapi.MxNPort.FlowCtrl
Constructor of FlowCtrl, initial the serial flow control settings by input values.
flush(int) - Method in interface com.moxa.mxnportapi.MxNPort
Flushes any data in the driver's input/output buffer.
FLUSH_INPUT - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines the flush to read buffer
FLUSH_OUTPUT - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines the flush to write buffer
framing_error - Variable in class com.moxa.mxnportapi.MxNPort.LineError
Available constants: LINE_NO_ERROR, LINE_ERROR.

G

getBaud() - Method in interface com.moxa.mxnportapi.MxNPort
Get the serial port baud rate setting.
getDebugMessage() - Method in exception com.moxa.mxnportapi.MxException
This is reserved for internal debugging purposes.
getErrorCode() - Method in exception com.moxa.mxnportapi.MxException
Gets the MxUPortAPI error code.
getErrorCodeString() - Method in exception com.moxa.mxnportapi.MxException
Gets the MxUPortAPI error string.
getFlowCtrl() - Method in interface com.moxa.mxnportapi.MxNPort
Get the serial port's hardware and software flow control settings.
getIoctlMode() - Method in interface com.moxa.mxnportapi.MxNPort
Gets the serial port's mode settings, such as data bits, parity, and stop bits.
getLineStatus() - Method in interface com.moxa.mxnportapi.MxNPort
Checks if errors occurred when receiving data; returns and cleans the error during the transaction.
getModemStatus() - Method in interface com.moxa.mxnportapi.MxNPort
Gets the line status, such as CTS, DSR, DCD, or RI.
getNPortInfoList() - Static method in class com.moxa.mxnportapi.MxNPortService
Builds and returns a new List<MxNPort> from the attached NPort in the same subnet, or returns null if a NPort is not available in system.
getNPortIPAddress(int) - Method in interface com.moxa.mxnportapi.MxNPort
Returns the IP address of a NPort devices.
getNPortMACAddress(int) - Method in interface com.moxa.mxnportapi.MxNPort
Returns the MAC address of a NPort devices.
getNPortMaximumPort() - Method in interface com.moxa.mxnportapi.MxNPort
Returns the total serial port number of a NPort device.
getNPortModelName() - Method in interface com.moxa.mxnportapi.MxNPort
Returns the model name of a NPort device.
getNPortPortIndex() - Method in interface com.moxa.mxnportapi.MxNPort
Returns the using serial port number of a NPort device.
getOQueue() - Method in interface com.moxa.mxnportapi.MxNPort
Gets the length (in bytes) remaining in the output buffer.
getString() - Method in enum com.moxa.mxnportapi.MxException.ErrorCode
Get the description of this error.
getString() - Static method in class com.moxa.mxnportapi.Version
Gets a version string.

I

IoctlMode() - Constructor for class com.moxa.mxnportapi.MxNPort.IoctlMode
Constructor of IoctlMode, initial the serial parameters by default values.
IoctlMode(int, int, int, int) - Constructor for class com.moxa.mxnportapi.MxNPort.IoctlMode
Constructor of IoctlMode, initial the serial parameters by input values.

L

LINE_ERROR - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines the error state for each field
LINE_NO_ERROR - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines the non-error state for each field
LineError() - Constructor for class com.moxa.mxnportapi.MxNPort.LineError
 

M

mBuild - Static variable in class com.moxa.mxnportapi.Version
Build number
mMajor - Static variable in class com.moxa.mxnportapi.Version
Major release number
mMinor - Static variable in class com.moxa.mxnportapi.Version
Minor release number
ModemStatus() - Constructor for class com.moxa.mxnportapi.MxNPort.ModemStatus
 
mRevision - Static variable in class com.moxa.mxnportapi.Version
Revision release number
MxException - Exception in com.moxa.mxnportapi
MxException represents the exception of MxNPortAPI.
MxException.ErrorCode - Enum in com.moxa.mxnportapi
 
MxNPort - Interface in com.moxa.mxnportapi
Each MxNPort object is mapping to a serial port from attache NPort.
MxNPort.FlowCtrl - Class in com.moxa.mxnportapi
This class represents serial flow control settings.
MxNPort.IoctlMode - Class in com.moxa.mxnportapi
This class represents serial parameters such as baud rate, data bits, parity, and stop bits.
MxNPort.LineError - Class in com.moxa.mxnportapi
This class represents errors on line.
MxNPort.ModemStatus - Class in com.moxa.mxnportapi
This class represents modem status, such as CTS, DSR, DCD, and RI.
MxNPortService - Class in com.moxa.mxnportapi
Created by user on 2017/8/9.
MxNPortService() - Constructor for class com.moxa.mxnportapi.MxNPortService
 

O

open() - Method in interface com.moxa.mxnportapi.MxNPort
Open a COM port for data transmitting/receiving.
overrun_error - Variable in class com.moxa.mxnportapi.MxNPort.LineError
Available constants: LINE_NO_ERROR, LINE_ERROR.

P

parity - Variable in class com.moxa.mxnportapi.MxNPort.IoctlMode
parity_error - Variable in class com.moxa.mxnportapi.MxNPort.LineError
Available constants: LINE_NO_ERROR, LINE_ERROR.
PARITY_EVEN - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines even parity checking
PARITY_MARK - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines mark parity checking
PARITY_NONE - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines no parity checking
PARITY_ODD - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines odd parity checking
PARITY_SPACE - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines space parity checking

R

read(byte[]) - Method in interface com.moxa.mxnportapi.MxNPort
Reads data from the port; returns the data if the buffer is full.
read(byte[], int) - Method in interface com.moxa.mxnportapi.MxNPort
Reads data from a port; returns the data if the given length of data has been received.
read(byte[], int, int) - Method in interface com.moxa.mxnportapi.MxNPort
Reads data from the port; returns the data if the given length of data has been received.
RI - Variable in class com.moxa.mxnportapi.MxNPort.ModemStatus
Available constants: RI_ON, RI_OFF.
RI_OFF - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines RI state OFF
RI_ON - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines RI state ON
RTS_FLOW_ENABLE - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines RTS hardware flow control
RTS_OFF - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines RTS state OFF
RTS_ON - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines RTS state ON
RtsCts - Variable in class com.moxa.mxnportapi.MxNPort.FlowCtrl
RTSCTS_FLOW_ENABLE - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines RTS/CTS hardware flow control
RTSCTS_FLOW_MASK - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines bit mask of RTS/CTS hardware flow control

S

setBaud(int) - Method in interface com.moxa.mxnportapi.MxNPort
Sets the baud rate using the actual speed value.
setBreak(int) - Method in interface com.moxa.mxnportapi.MxNPort
Sends out a break signal.
setDTR(int) - Method in interface com.moxa.mxnportapi.MxNPort
Sets the DTR state for a serial port.
setFlowCtrl(MxNPort.FlowCtrl) - Method in interface com.moxa.mxnportapi.MxNPort
Sets the hardware and/or software flow control.
setIoctlMode(MxNPort.IoctlMode) - Method in interface com.moxa.mxnportapi.MxNPort
Configures communication parameters, such as baud rate, parity, data bits, stop bits and flow control settings.
setRTS(int) - Method in interface com.moxa.mxnportapi.MxNPort
Sets the RTS state for a serial port.
STOP_BITS_1 - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines 1 stop bit on serial communication
STOP_BITS_1_5 - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines 1.5 stop bits on serial communication
STOP_BITS_2 - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines 2 stop bits on serial communication
stopBits - Variable in class com.moxa.mxnportapi.MxNPort.IoctlMode
Available constants: STOP_BITS_1, STOP_BITS_1_5, STOP_BITS_2.

V

valueOf(String) - Static method in enum com.moxa.mxnportapi.MxException.ErrorCode
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.moxa.mxnportapi.MxException.ErrorCode
Returns an array containing the constants of this enum type, in the order they are declared.
Version - Class in com.moxa.mxnportapi
The release information about this library.

W

write(byte[]) - Method in interface com.moxa.mxnportapi.MxNPort
Puts a block of data to the driver's output buffer.
write(byte[], int) - Method in interface com.moxa.mxnportapi.MxNPort
Puts a block of data to the driver's output buffer.
write(byte[], int, int) - Method in interface com.moxa.mxnportapi.MxNPort
Puts a block of data to the driver's output buffer.

X

XOFF_FLOW_ENABLE - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines software auto receive flow control
XON_FLOW_ENABLE - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines software auto transmit flow control
XonXoff - Variable in class com.moxa.mxnportapi.MxNPort.FlowCtrl
XONXOFF_FLOW_ENABLE - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines XON/XOFF software flow control
XONXOFF_FLOW_MASK - Static variable in interface com.moxa.mxnportapi.MxNPort
Defines the bit mask of RTS/CTS hardware flow control
B C D F G I L M O P R S V W X 
Skip navigation links