CommPort (Modbus Javacomm 1.6 API)

java.lang.Object
- com.sparetimelabs.serial.CommPort

Direct Known Subclasses:

SerialPort
```
public abstract class CommPort
extends Object
```
The type Comm port.

Field Summary

Fields
Modifier and Type Field and Description

protected String name
The Name.

Fields
Modifier and Type	Field and Description
`protected String`	`name` The Name.

Constructor Summary

Constructors
Constructor and Description

CommPort()

Constructors
Constructor and Description
`CommPort()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Closes the communications port.
`abstract void`	`disableReceiveFraming()` Disables receive framing.
`abstract void`	`disableReceiveThreshold()` Disables receive threshold.
`abstract void`	`disableReceiveTimeout()` Disables receive timeout.
`abstract void`	`enableReceiveFraming(int framingByte)` Enables receive framing.
`abstract void`	`enableReceiveThreshold(int threshold)` Enables receive threshold.
`abstract void`	`enableReceiveTimeout(int rcvTimeout)` Enables receive timeout.
`abstract int`	`getInputBufferSize()` Returns the input buffer size in bytes.
`abstract InputStream`	`getInputStream()` Returns an input stream.
`String`	`getName()` Returns the port name.
`abstract int`	`getOutputBufferSize()` Returns the output buffer size in bytes.
`abstract OutputStream`	`getOutputStream()` Returns an output stream.
`abstract int`	`getReceiveFramingByte()` Returns the current byte used for receive framing.
`abstract int`	`getReceiveThreshold()` Returns the integer value of the receive threshold.
`abstract int`	`getReceiveTimeout()` Returns the integer value of the receive timeout.
`abstract boolean`	`isReceiveFramingEnabled()` Returns `true` if receive framing is enabled.
`abstract boolean`	`isReceiveThresholdEnabled()` Returns `true` if receive threshold is enabled.
`abstract boolean`	`isReceiveTimeoutEnabled()` Returns `true` if receive timeout is enabled.
`abstract void`	`setInputBufferSize(int size)` Sets the input buffer size.
`abstract void`	`setOutputBufferSize(int size)` Sets the output buffer size.

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

- Field Detail
  - name
```
protected String name
```
    The Name.
- Constructor Detail
  - CommPort
```
public CommPort()
```
- Method Detail
  - close
```
public void close()
```
    Closes the communications port.
  - disableReceiveFraming
```
public abstract void disableReceiveFraming()
```
    Disables receive framing.
  - disableReceiveThreshold
```
public abstract void disableReceiveThreshold()
```
    Disables receive threshold.
  - disableReceiveTimeout
```
public abstract void disableReceiveTimeout()
```
    Disables receive timeout.
  - enableReceiveFraming
```
public abstract void enableReceiveFraming(int framingByte)
                                   throws UnsupportedCommOperationException
```
    Enables receive framing.
    
    Parameters:
    
    framingByte - the framing byte
    
    Throws:
    
    UnsupportedCommOperationException - the unsupported comm operation exception
  - enableReceiveThreshold
```
public abstract void enableReceiveThreshold(int threshold)
                                     throws UnsupportedCommOperationException
```
    Enables receive threshold.
    
    Parameters:
    
    threshold - the threshold
    
    Throws:
    
    UnsupportedCommOperationException - the unsupported comm operation exception
  - enableReceiveTimeout
```
public abstract void enableReceiveTimeout(int rcvTimeout)
                                   throws UnsupportedCommOperationException
```
    Enables receive timeout.
    
    Parameters:
    
    rcvTimeout - Timeout value in milliseconds
    
    Throws:
    
    UnsupportedCommOperationException - the unsupported comm operation exception
  - getInputBufferSize
```
public abstract int getInputBufferSize()
```
    Returns the input buffer size in bytes.
    
    Returns:
    
    The input buffer size in bytes.
  - getInputStream
```
public abstract InputStream getInputStream()
                                    throws IOException
```
    Returns an input stream.
    
    Returns:
    
    An input stream, or null if the port is unidirectional and doesn't support receiving data.
    
    Throws:
    
    IOException - the io exception
  - getName
```
public String getName()
```
    Returns the port name.
    
    Returns:
    
    The port name.
  - getOutputBufferSize
```
public abstract int getOutputBufferSize()
```
    Returns the output buffer size in bytes.
    
    Returns:
    
    The output buffer size in bytes.
  - getOutputStream
```
public abstract OutputStream getOutputStream()
                                      throws IOException
```
    Returns an output stream.
    
    Returns:
    
    An output stream, or null if the port is unidirectional and doesn't support sending data.
    
    Throws:
    
    IOException - the io exception
  - getReceiveFramingByte
```
public abstract int getReceiveFramingByte()
```
    Returns the current byte used for receive framing.
    
    Returns:
    
    The current byte used for receive framing.
  - getReceiveThreshold
```
public abstract int getReceiveThreshold()
```
    Returns the integer value of the receive threshold.
    
    Returns:
    
    The integer value of the receive threshold.
  - getReceiveTimeout
```
public abstract int getReceiveTimeout()
```
    Returns the integer value of the receive timeout. If the receive timeout is disabled, then the value returned is meaningless.
    
    Returns:
    
    The integer value of the receive timeout.
  - isReceiveFramingEnabled
```
public abstract boolean isReceiveFramingEnabled()
```
    Returns true if receive framing is enabled.
    
    Returns:
    
    true if receive framing is enabled.
  - isReceiveThresholdEnabled
```
public abstract boolean isReceiveThresholdEnabled()
```
    Returns true if receive threshold is enabled.
    
    Returns:
    
    true if receive threshold is enabled.
  - isReceiveTimeoutEnabled
```
public abstract boolean isReceiveTimeoutEnabled()
```
    Returns true if receive timeout is enabled.
    
    Returns:
    
    true if receive timeout is enabled.
  - setInputBufferSize
```
public abstract void setInputBufferSize(int size)
```
    Sets the input buffer size.
    
    Parameters:
    
    size - the size
  - setOutputBufferSize
```
public abstract void setOutputBufferSize(int size)
```
    Sets the output buffer size.
    
    Parameters:
    
    size - the size

Class CommPort

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

Constructor Detail

CommPort

Method Detail

close

disableReceiveFraming

disableReceiveThreshold

disableReceiveTimeout

enableReceiveFraming

enableReceiveThreshold

enableReceiveTimeout

getInputBufferSize

getInputStream

getName

getOutputBufferSize

getOutputStream

getReceiveFramingByte

getReceiveThreshold

getReceiveTimeout

isReceiveFramingEnabled

isReceiveThresholdEnabled

isReceiveTimeoutEnabled

setInputBufferSize

setOutputBufferSize