RxtxChannelConfig (Netty 4.1.109.Final API文档

所有超级接口:: ChannelConfig

已过时。

this transport will be removed in the next major version.

@Deprecated
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)`

嵌套类概要

嵌套类
限定符和类型	接口和说明
`static class`	`RxtxChannelConfig.Databits` 已过时。
`static class`	`RxtxChannelConfig.Paritybit` 已过时。
`static class`	`RxtxChannelConfig.Stopbits` 已过时。

方法概要

All Methods Instance Methods Abstract Methods Deprecated Methods
限定符和类型	方法和说明
`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)` 已过时。 Sets whether the `Channel` should be closed automatically and immediately on write failure.
`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)` 已过时。
`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.

从接口继承的方法 io.netty.channel.ChannelConfig
getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getOption, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setOption, setOptions

- 方法详细资料
  - 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.
    
    参数:
    
    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.
    
    参数:
    
    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.
    
    参数:
    
    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.
    
    参数:
    
    paritybit - The type of parity bit to be used
  - getBaudrate
```
int getBaudrate()
```
    已过时。
    
    返回:
    
    The configured baud rate, defaulting to 115200 if unset
  - getStopbits
```
RxtxChannelConfig.Stopbits getStopbits()
```
    已过时。
    
    返回:
    
    The configured stop bits, defaulting to RxtxChannelConfig.Stopbits.STOPBITS_1 if unset
  - getDatabits
```
RxtxChannelConfig.Databits getDatabits()
```
    已过时。
    
    返回:
    
    The configured data bits, defaulting to RxtxChannelConfig.Databits.DATABITS_8 if unset
  - getParitybit
```
RxtxChannelConfig.Paritybit getParitybit()
```
    已过时。
    
    返回:
    
    The configured parity bit, defaulting to RxtxChannelConfig.Paritybit.NONE if unset
  - isDtr
```
boolean isDtr()
```
    已过时。
    
    返回:
    
    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
    
    参数:
    
    dtr - true if DTR is supported, false otherwise
  - isRts
```
boolean isRts()
```
    已过时。
    
    返回:
    
    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
    
    参数:
    
    rts - true if RTS is supported, false otherwise
  - getWaitTimeMillis
```
int getWaitTimeMillis()
```
    已过时。
    
    返回:
    
    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.
    
    参数:
    
    waitTimeMillis - The number of milliseconds to wait, defaulting to 0 (no wait) if unset
    
    抛出:
    
    java.lang.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)
```
    已过时。
    
    从接口复制的说明: 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.
    
    指定者:
    
    setConnectTimeoutMillis 在接口中 ChannelConfig
    
    参数:
    
    connectTimeoutMillis - the connect timeout in milliseconds. 0 to disable.
  - setMaxMessagesPerRead
```
@Deprecated
RxtxChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)
```
    已过时。
    
    指定者:
    
    setMaxMessagesPerRead 在接口中 ChannelConfig
  - setWriteSpinCount
```
RxtxChannelConfig setWriteSpinCount(int writeSpinCount)
```
    已过时。
    
    从接口复制的说明: 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.
    
    指定者:
    
    setWriteSpinCount 在接口中 ChannelConfig
  - setAllocator
```
RxtxChannelConfig setAllocator(ByteBufAllocator allocator)
```
    已过时。
    
    从接口复制的说明: ChannelConfig
    
    Set the ByteBufAllocator which is used for the channel to allocate buffers.
    
    指定者:
    
    setAllocator 在接口中 ChannelConfig
  - setRecvByteBufAllocator
```
RxtxChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)
```
    已过时。
    
    从接口复制的说明: ChannelConfig
    
    Set the RecvByteBufAllocator which is used for the channel to allocate receive buffers.
    
    指定者:
    
    setRecvByteBufAllocator 在接口中 ChannelConfig
  - setAutoRead
```
RxtxChannelConfig setAutoRead(boolean autoRead)
```
    已过时。
    
    从接口复制的说明: 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.
    
    指定者:
    
    setAutoRead 在接口中 ChannelConfig
  - setAutoClose
```
RxtxChannelConfig setAutoClose(boolean autoClose)
```
    已过时。
    
    从接口复制的说明: ChannelConfig
    
    Sets whether the Channel should be closed automatically and immediately on write failure. The default is true.
    
    指定者:
    
    setAutoClose 在接口中 ChannelConfig
  - setWriteBufferHighWaterMark
```
RxtxChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)
```
    已过时。
    
    从接口复制的说明: 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.
    
    指定者:
    
    setWriteBufferHighWaterMark 在接口中 ChannelConfig
  - setWriteBufferLowWaterMark
```
RxtxChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)
```
    已过时。
    
    从接口复制的说明: 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.
    
    指定者:
    
    setWriteBufferLowWaterMark 在接口中 ChannelConfig
  - setWriteBufferWaterMark
```
RxtxChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)
```
    已过时。
    
    从接口复制的说明: ChannelConfig
    
    Set the WriteBufferWaterMark which is used for setting the high and low water mark of the write buffer.
    
    指定者:
    
    setWriteBufferWaterMark 在接口中 ChannelConfig
  - setMessageSizeEstimator
```
RxtxChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)
```
    已过时。
    
    从接口复制的说明: ChannelConfig
    
    Set the MessageSizeEstimator which is used for the channel to detect the size of a message.
    
    指定者:
    
    setMessageSizeEstimator 在接口中 ChannelConfig

接口 RxtxChannelConfig

Available options

嵌套类概要

方法概要

从接口继承的方法 io.netty.channel.ChannelConfig

方法详细资料

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