AbstractSerialConnection (j2mod 3.3.0 API)

java.lang.Object
- com.ghgande.j2mod.modbus.net.AbstractSerialConnection

Direct Known Subclasses:

SerialConnection
```
public abstract class AbstractSerialConnection
extends Object
```
Interface that represents a public abstract serial port connection

Version:

2.0 (March 2016)

Author:

Felipe Herranz

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`EVEN_PARITY`
`static int`	`FLOW_CONTROL_CTS_ENABLED`
`static int`	`FLOW_CONTROL_DISABLED` Flow control values
`static int`	`FLOW_CONTROL_DSR_ENABLED`
`static int`	`FLOW_CONTROL_DTR_ENABLED`
`static int`	`FLOW_CONTROL_RTS_ENABLED`
`static int`	`FLOW_CONTROL_XONXOFF_IN_ENABLED`
`static int`	`FLOW_CONTROL_XONXOFF_OUT_ENABLED`
`static int`	`MARK_PARITY`
`static int`	`NO_PARITY` Parity values
`static int`	`ODD_PARITY`
`static int`	`ONE_POINT_FIVE_STOP_BITS`
`static int`	`ONE_STOP_BIT` Stop bits values
`static int`	`OPEN_DELAY` Open delay (msec)
`static int`	`SPACE_PARITY`
`static int`	`TIMEOUT_NONBLOCKING` Timeout
`static int`	`TIMEOUT_READ_BLOCKING`
`static int`	`TIMEOUT_READ_SEMI_BLOCKING`
`static int`	`TIMEOUT_SCANNER`
`static int`	`TIMEOUT_WRITE_BLOCKING`
`static int`	`TWO_STOP_BITS`

Constructor Summary

Constructors
Constructor and Description

AbstractSerialConnection()

Constructors
Constructor and Description
`AbstractSerialConnection()`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`abstract int`	`bytesAvailable()` Bytes available to read
`abstract void`	`close()` Close the port and clean up associated elements
`abstract int`	`getBaudRate()` Returns current baud rate
`abstract Set<String>`	`getCommPorts()` Returns a set of all the available comm port names
`abstract String`	`getDescriptivePortName()` Returns a descriptive name of the port
`abstract AbstractModbusTransport`	`getModbusTransport()` Returns the `ModbusTransport` instance to be used for receiving and sending messages.
`abstract int`	`getNumDataBits()` Returns current data bits value
`abstract int`	`getNumStopBits()` Returns current stop bits
`abstract int`	`getParity()` Returns current parity
`abstract String`	`getPortName()` Returns a name of the port
`abstract int`	`getTimeout()` Returns the timeout for this connection
`abstract boolean`	`isOpen()` Reports the open status of the port
`abstract void`	`open()` Opens the port and throws an error if it cannot for some reason
`abstract int`	`readBytes(byte[] buffer, int bytesToRead)` Read a specified number of bytes from the serial port
`abstract void`	`setComPortTimeouts(int newTimeoutMode, int newReadTimeout, int newWriteTimeout)` Set port timeouts
`abstract void`	`setTimeout(int timeout)` Sets the timeout for this connection.
`abstract int`	`writeBytes(byte[] buffer, int bytesToWrite)` Write a specified number of bytes to the serial port

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NO_PARITY
```
public static final int NO_PARITY
```
    Parity values
    
    See Also:
    
    Constant Field Values
  - ODD_PARITY
```
public static final int ODD_PARITY
```
    See Also:
    
    Constant Field Values
  - EVEN_PARITY
```
public static final int EVEN_PARITY
```
    See Also:
    
    Constant Field Values
  - MARK_PARITY
```
public static final int MARK_PARITY
```
    See Also:
    
    Constant Field Values
  - SPACE_PARITY
```
public static final int SPACE_PARITY
```
    See Also:
    
    Constant Field Values
  - ONE_STOP_BIT
```
public static final int ONE_STOP_BIT
```
    Stop bits values
    
    See Also:
    
    Constant Field Values
  - ONE_POINT_FIVE_STOP_BITS
```
public static final int ONE_POINT_FIVE_STOP_BITS
```
    See Also:
    
    Constant Field Values
  - TWO_STOP_BITS
```
public static final int TWO_STOP_BITS
```
    See Also:
    
    Constant Field Values
  - FLOW_CONTROL_DISABLED
```
public static final int FLOW_CONTROL_DISABLED
```
    Flow control values
    
    See Also:
    
    Constant Field Values
  - FLOW_CONTROL_RTS_ENABLED
```
public static final int FLOW_CONTROL_RTS_ENABLED
```
    See Also:
    
    Constant Field Values
  - FLOW_CONTROL_CTS_ENABLED
```
public static final int FLOW_CONTROL_CTS_ENABLED
```
    See Also:
    
    Constant Field Values
  - FLOW_CONTROL_DSR_ENABLED
```
public static final int FLOW_CONTROL_DSR_ENABLED
```
    See Also:
    
    Constant Field Values
  - FLOW_CONTROL_DTR_ENABLED
```
public static final int FLOW_CONTROL_DTR_ENABLED
```
    See Also:
    
    Constant Field Values
  - FLOW_CONTROL_XONXOFF_IN_ENABLED
```
public static final int FLOW_CONTROL_XONXOFF_IN_ENABLED
```
    See Also:
    
    Constant Field Values
  - FLOW_CONTROL_XONXOFF_OUT_ENABLED
```
public static final int FLOW_CONTROL_XONXOFF_OUT_ENABLED
```
    See Also:
    
    Constant Field Values
  - OPEN_DELAY
```
public static final int OPEN_DELAY
```
    Open delay (msec)
    
    See Also:
    
    Constant Field Values
  - TIMEOUT_NONBLOCKING
```
public static final int TIMEOUT_NONBLOCKING
```
    Timeout
    
    See Also:
    
    Constant Field Values
  - TIMEOUT_READ_SEMI_BLOCKING
```
public static final int TIMEOUT_READ_SEMI_BLOCKING
```
    See Also:
    
    Constant Field Values
  - TIMEOUT_READ_BLOCKING
```
public static final int TIMEOUT_READ_BLOCKING
```
    See Also:
    
    Constant Field Values
  - TIMEOUT_WRITE_BLOCKING
```
public static final int TIMEOUT_WRITE_BLOCKING
```
    See Also:
    
    Constant Field Values
  - TIMEOUT_SCANNER
```
public static final int TIMEOUT_SCANNER
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractSerialConnection
```
public AbstractSerialConnection()
```
- Method Detail
  - open
```
public abstract void open()
                   throws IOException
```
    Opens the port and throws an error if it cannot for some reason
    
    Throws:
    
    IOException - If the port is not available or cannot be opened
  - getModbusTransport
```
public abstract AbstractModbusTransport getModbusTransport()
```
    Returns the ModbusTransport instance to be used for receiving and sending messages.
    
    Returns:
    
    a ModbusTransport instance
  - readBytes
```
public abstract int readBytes(byte[] buffer,
                              int bytesToRead)
```
    Read a specified number of bytes from the serial port
    
    Parameters:
    
    buffer - Buffer to recieve bytes from the port
    
    bytesToRead - Number of bytes to read
    
    Returns:
    
    number of currently bytes read
  - writeBytes
```
public abstract int writeBytes(byte[] buffer,
                               int bytesToWrite)
```
    Write a specified number of bytes to the serial port
    
    Parameters:
    
    buffer - Bytes to send to the port
    
    bytesToWrite - How many bytes to send
    
    Returns:
    
    number of currently bytes written
  - bytesAvailable
```
public abstract int bytesAvailable()
```
    Bytes available to read
    
    Returns:
    
    number of bytes currently available to read
  - close
```
public abstract void close()
```
    Close the port and clean up associated elements
  - getBaudRate
```
public abstract int getBaudRate()
```
    Returns current baud rate
    
    Returns:
    
    Baud rate
  - getNumDataBits
```
public abstract int getNumDataBits()
```
    Returns current data bits value
    
    Returns:
    
    Number of data bits
  - getNumStopBits
```
public abstract int getNumStopBits()
```
    Returns current stop bits
    
    Returns:
    
    Number of stop bits
  - getParity
```
public abstract int getParity()
```
    Returns current parity
    
    Returns:
    
    Parity type
  - getPortName
```
public abstract String getPortName()
```
    Returns a name of the port
    
    Returns:
    
    a String instance
  - getDescriptivePortName
```
public abstract String getDescriptivePortName()
```
    Returns a descriptive name of the port
    
    Returns:
    
    a String instance
  - setComPortTimeouts
```
public abstract void setComPortTimeouts(int newTimeoutMode,
                                        int newReadTimeout,
                                        int newWriteTimeout)
```
    Set port timeouts
    
    Parameters:
    
    newTimeoutMode - Timeout mode
    
    newReadTimeout - Read timeout (milliseconds)
    
    newWriteTimeout - Write timeout (milliseconds)
  - isOpen
```
public abstract boolean isOpen()
```
    Reports the open status of the port
    
    Returns:
    
    true if port is open, false if port is closed
  - getTimeout
```
public abstract int getTimeout()
```
    Returns the timeout for this connection
    
    Returns:
    
    the timeout as int milliseconds
  - setTimeout
```
public abstract void setTimeout(int timeout)
```
    Sets the timeout for this connection.
    
    Parameters:
    
    timeout - the timeout as int milliseconds
  - getCommPorts
```
public abstract Set<String> getCommPorts()
```
    Returns a set of all the available comm port names
    
    Returns:
    
    Set of comm port names

Class AbstractSerialConnection

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NO_PARITY

ODD_PARITY

EVEN_PARITY

MARK_PARITY

SPACE_PARITY

ONE_STOP_BIT

ONE_POINT_FIVE_STOP_BITS

TWO_STOP_BITS

FLOW_CONTROL_DISABLED

FLOW_CONTROL_RTS_ENABLED

FLOW_CONTROL_CTS_ENABLED

FLOW_CONTROL_DSR_ENABLED

FLOW_CONTROL_DTR_ENABLED

FLOW_CONTROL_XONXOFF_IN_ENABLED

FLOW_CONTROL_XONXOFF_OUT_ENABLED

OPEN_DELAY

TIMEOUT_NONBLOCKING

TIMEOUT_READ_SEMI_BLOCKING

TIMEOUT_READ_BLOCKING

TIMEOUT_WRITE_BLOCKING

TIMEOUT_SCANNER

Constructor Detail

AbstractSerialConnection

Method Detail

open

getModbusTransport

readBytes

writeBytes

bytesAvailable

close

getBaudRate

getNumDataBits

getNumStopBits

getParity

getPortName

getDescriptivePortName

setComPortTimeouts

isOpen

getTimeout

setTimeout

getCommPorts