RxtxChannelConfig (Netty API Reference (4.1.11.Final))

All Superinterfaces:: ChannelConfig

public interface RxtxChannelConfig
extends ChannelConfig

A configuration class for RXTX device connections.

Available options

In addition to the options provided by ChannelConfig, DefaultRxtxChannelConfig allows the following options in the option map:

Name	Associated setter method
`RxtxChannelOption.BAUD_RATE`	`setBaudrate(int)`
`RxtxChannelOption.DTR`	`setDtr(boolean)`
`RxtxChannelOption.RTS`	`setRts(boolean)`
`RxtxChannelOption.STOP_BITS`	`setStopbits(Stopbits)`
`RxtxChannelOption.DATA_BITS`	`setDatabits(Databits)`
`RxtxChannelOption.PARITY_BIT`	`setParitybit(Paritybit)`
`RxtxChannelOption.WAIT_TIME`	`setWaitTimeMillis(int)`

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`RxtxChannelConfig.Databits`
`static class`	`RxtxChannelConfig.Paritybit`
`static class`	`RxtxChannelConfig.Stopbits`

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`getBaudrate()`
`RxtxChannelConfig.Databits`	`getDatabits()`
`RxtxChannelConfig.Paritybit`	`getParitybit()`
`int`	`getReadTimeout()` Return the maximal time (in ms) to block and wait for something to be ready to read.
`RxtxChannelConfig.Stopbits`	`getStopbits()`
`int`	`getWaitTimeMillis()`
`boolean`	`isDtr()`
`boolean`	`isRts()`
`RxtxChannelConfig`	`setAllocator(ByteBufAllocator allocator)` Set the `ByteBufAllocator` which is used for the channel to allocate buffers.
`RxtxChannelConfig`	`setAutoClose(boolean autoClose)`
`RxtxChannelConfig`	`setAutoRead(boolean autoRead)` Sets if `ChannelHandlerContext.read()` will be invoked automatically so that a user application doesn't need to call it at all.
`RxtxChannelConfig`	`setBaudrate(int baudrate)` Sets the baud rate (ie. bits per second) for communication with the serial device.
`RxtxChannelConfig`	`setConnectTimeoutMillis(int connectTimeoutMillis)` Sets the connect timeout of the channel in milliseconds.
`RxtxChannelConfig`	`setDatabits(RxtxChannelConfig.Databits databits)` Sets the number of data bits to use to make up each character sent to the serial device.
`RxtxChannelConfig`	`setDtr(boolean dtr)` Sets whether the serial device supports the Data Terminal Ready signal, used for flow control
`RxtxChannelConfig`	`setMaxMessagesPerRead(int maxMessagesPerRead)` Deprecated.
`RxtxChannelConfig`	`setMessageSizeEstimator(MessageSizeEstimator estimator)` Set the `MessageSizeEstimator` which is used for the channel to detect the size of a message.
`RxtxChannelConfig`	`setParitybit(RxtxChannelConfig.Paritybit paritybit)` Sets the type of parity bit to be used when communicating with the serial device.
`RxtxChannelConfig`	`setReadTimeout(int readTimeout)` Sets the maximal time (in ms) to block while try to read from the serial port.
`RxtxChannelConfig`	`setRecvByteBufAllocator(RecvByteBufAllocator allocator)` Set the `RecvByteBufAllocator` which is used for the channel to allocate receive buffers.
`RxtxChannelConfig`	`setRts(boolean rts)` Sets whether the serial device supports the Request To Send signal, used for flow control
`RxtxChannelConfig`	`setStopbits(RxtxChannelConfig.Stopbits stopbits)` Sets the number of stop bits to include at the end of every character to aid the serial device in synchronising with the data.
`RxtxChannelConfig`	`setWaitTimeMillis(int waitTimeMillis)` Sets the time to wait after opening the serial port and before sending it any configuration information or data.
`RxtxChannelConfig`	`setWriteBufferHighWaterMark(int writeBufferHighWaterMark)` Sets the high water mark of the write buffer.
`RxtxChannelConfig`	`setWriteBufferLowWaterMark(int writeBufferLowWaterMark)` Sets the low water mark of the write buffer.
`RxtxChannelConfig`	`setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)` Set the `WriteBufferWaterMark` which is used for setting the high and low water mark of the write buffer.
`RxtxChannelConfig`	`setWriteSpinCount(int writeSpinCount)` Sets the maximum loop count for a write operation until `WritableByteChannel.write(ByteBuffer)` returns a non-zero value.

Methods inherited from interface io.netty.channel.ChannelConfig
getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getOption, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setOption, setOptions

- Method Detail
  - setBaudrate
```
RxtxChannelConfig setBaudrate(int baudrate)
```
    Sets the baud rate (ie. bits per second) for communication with the serial device. The baud rate will include bits for framing (in the form of stop bits and parity), such that the effective data rate will be lower than this value.
    
    Parameters:
    
    baudrate - The baud rate (in bits per second)
  - setStopbits
```
RxtxChannelConfig setStopbits(RxtxChannelConfig.Stopbits stopbits)
```
    Sets the number of stop bits to include at the end of every character to aid the serial device in synchronising with the data.
    
    Parameters:
    
    stopbits - The number of stop bits to use
  - setDatabits
```
RxtxChannelConfig setDatabits(RxtxChannelConfig.Databits databits)
```
    Sets the number of data bits to use to make up each character sent to the serial device.
    
    Parameters:
    
    databits - The number of data bits to use
  - setParitybit
```
RxtxChannelConfig setParitybit(RxtxChannelConfig.Paritybit paritybit)
```
    Sets the type of parity bit to be used when communicating with the serial device.
    
    Parameters:
    
    paritybit - The type of parity bit to be used
  - getBaudrate
```
int getBaudrate()
```
    Returns:
    
    The configured baud rate, defaulting to 115200 if unset
  - getStopbits
```
RxtxChannelConfig.Stopbits getStopbits()
```
    Returns:
    
    The configured stop bits, defaulting to RxtxChannelConfig.Stopbits.STOPBITS_1 if unset
  - getDatabits
```
RxtxChannelConfig.Databits getDatabits()
```
    Returns:
    
    The configured data bits, defaulting to RxtxChannelConfig.Databits.DATABITS_8 if unset
  - getParitybit
```
RxtxChannelConfig.Paritybit getParitybit()
```
    Returns:
    
    The configured parity bit, defaulting to RxtxChannelConfig.Paritybit.NONE if unset
  - isDtr
```
boolean isDtr()
```
    Returns:
    
    true if the serial device should support the Data Terminal Ready signal
  - setDtr
```
RxtxChannelConfig setDtr(boolean dtr)
```
    Sets whether the serial device supports the Data Terminal Ready signal, used for flow control
    
    Parameters:
    
    dtr - true if DTR is supported, false otherwise
  - isRts
```
boolean isRts()
```
    Returns:
    
    true if the serial device should support the Ready to Send signal
  - setRts
```
RxtxChannelConfig setRts(boolean rts)
```
    Sets whether the serial device supports the Request To Send signal, used for flow control
    
    Parameters:
    
    rts - true if RTS is supported, false otherwise
  - getWaitTimeMillis
```
int getWaitTimeMillis()
```
    Returns:
    
    The number of milliseconds to wait between opening the serial port and initialising.
  - setWaitTimeMillis
```
RxtxChannelConfig setWaitTimeMillis(int waitTimeMillis)
```
    Sets the time to wait after opening the serial port and before sending it any configuration information or data. A value of 0 indicates that no waiting should occur.
    
    Parameters:
    
    waitTimeMillis - The number of milliseconds to wait, defaulting to 0 (no wait) if unset
    
    Throws:
    
    IllegalArgumentException - if the supplied value is < 0
  - setReadTimeout
```
RxtxChannelConfig setReadTimeout(int readTimeout)
```
    Sets the maximal time (in ms) to block while try to read from the serial port. Default is 1000ms
  - getReadTimeout
```
int getReadTimeout()
```
    Return the maximal time (in ms) to block and wait for something to be ready to read.
  - setConnectTimeoutMillis
```
RxtxChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)
```
    Description copied from interface: ChannelConfig
    
    Sets the connect timeout of the channel in milliseconds. If the Channel does not support connect operation, this property is not used at all, and therefore will be ignored.
    
    Specified by:
    
    setConnectTimeoutMillis in interface ChannelConfig
    
    Parameters:
    
    connectTimeoutMillis - the connect timeout in milliseconds. 0 to disable.
  - setMaxMessagesPerRead
```
@Deprecated
RxtxChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)
```
    Deprecated.
    
    Specified by:
    
    setMaxMessagesPerRead in interface ChannelConfig
  - setWriteSpinCount
```
RxtxChannelConfig setWriteSpinCount(int writeSpinCount)
```
    Description copied from interface: ChannelConfig
    
    Sets the maximum loop count for a write operation until WritableByteChannel.write(ByteBuffer) returns a non-zero value. It is similar to what a spin lock is used for in concurrency programming. It improves memory utilization and write throughput depending on the platform that JVM runs on. The default value is 16.
    
    Specified by:
    
    setWriteSpinCount in interface ChannelConfig
  - setAllocator
```
RxtxChannelConfig setAllocator(ByteBufAllocator allocator)
```
    Description copied from interface: ChannelConfig
    
    Set the ByteBufAllocator which is used for the channel to allocate buffers.
    
    Specified by:
    
    setAllocator in interface ChannelConfig
  - setRecvByteBufAllocator
```
RxtxChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)
```
    Description copied from interface: ChannelConfig
    
    Set the RecvByteBufAllocator which is used for the channel to allocate receive buffers.
    
    Specified by:
    
    setRecvByteBufAllocator in interface ChannelConfig
  - setAutoRead
```
RxtxChannelConfig setAutoRead(boolean autoRead)
```
    Description copied from interface: ChannelConfig
    
    Sets if ChannelHandlerContext.read() will be invoked automatically so that a user application doesn't need to call it at all. The default value is true.
    
    Specified by:
    
    setAutoRead in interface ChannelConfig
  - setAutoClose
```
RxtxChannelConfig setAutoClose(boolean autoClose)
```
    Specified by:
    
    setAutoClose in interface ChannelConfig
  - setWriteBufferHighWaterMark
```
RxtxChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)
```
    Description copied from interface: ChannelConfig
    
    Sets the high water mark of the write buffer. If the number of bytes queued in the write buffer exceeds this value, Channel.isWritable() will start to return false.
    
    Specified by:
    
    setWriteBufferHighWaterMark in interface ChannelConfig
  - setWriteBufferLowWaterMark
```
RxtxChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)
```
    Description copied from interface: ChannelConfig
    
    Sets the low water mark of the write buffer. Once the number of bytes queued in the write buffer exceeded the high water mark and then dropped down below this value, Channel.isWritable() will start to return true again.
    
    Specified by:
    
    setWriteBufferLowWaterMark in interface ChannelConfig
  - setWriteBufferWaterMark
```
RxtxChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)
```
    Description copied from interface: ChannelConfig
    
    Set the WriteBufferWaterMark which is used for setting the high and low water mark of the write buffer.
    
    Specified by:
    
    setWriteBufferWaterMark in interface ChannelConfig
  - setMessageSizeEstimator
```
RxtxChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)
```
    Description copied from interface: ChannelConfig
    
    Set the MessageSizeEstimator which is used for the channel to detect the size of a message.
    
    Specified by:
    
    setMessageSizeEstimator in interface ChannelConfig

Interface RxtxChannelConfig

Available options

Nested Class Summary

Method Summary

Methods inherited from interface io.netty.channel.ChannelConfig

Method Detail

setBaudrate

setStopbits

setDatabits

setParitybit

getBaudrate

getStopbits

getDatabits

getParitybit

isDtr

setDtr

isRts

setRts

getWaitTimeMillis

setWaitTimeMillis

setReadTimeout

getReadTimeout

setConnectTimeoutMillis

setMaxMessagesPerRead

setWriteSpinCount

setAllocator

setRecvByteBufAllocator

setAutoRead

setAutoClose

setWriteBufferHighWaterMark

setWriteBufferLowWaterMark

setWriteBufferWaterMark

setMessageSizeEstimator