Package io.netty.channel.rxtx
Interface RxtxChannelConfig
-
- All Superinterfaces:
io.netty.channel.ChannelConfig
@Deprecated public interface RxtxChannelConfig extends io.netty.channel.ChannelConfig
Deprecated.this transport will be removed in the next major version.A configuration class for RXTX device connections.Available options
In addition to the options provided byChannelConfig,DefaultRxtxChannelConfigallows the following options in the option map:
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classRxtxChannelConfig.DatabitsDeprecated.static classRxtxChannelConfig.ParitybitDeprecated.static classRxtxChannelConfig.StopbitsDeprecated.
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description intgetBaudrate()Deprecated.RxtxChannelConfig.DatabitsgetDatabits()Deprecated.RxtxChannelConfig.ParitybitgetParitybit()Deprecated.intgetReadTimeout()Deprecated.Return the maximal time (in ms) to block and wait for something to be ready to read.RxtxChannelConfig.StopbitsgetStopbits()Deprecated.intgetWaitTimeMillis()Deprecated.booleanisDtr()Deprecated.booleanisRts()Deprecated.RxtxChannelConfigsetAllocator(io.netty.buffer.ByteBufAllocator allocator)Deprecated.RxtxChannelConfigsetAutoClose(boolean autoClose)Deprecated.RxtxChannelConfigsetAutoRead(boolean autoRead)Deprecated.RxtxChannelConfigsetBaudrate(int baudrate)Deprecated.Sets the baud rate (ie. bits per second) for communication with the serial device.RxtxChannelConfigsetConnectTimeoutMillis(int connectTimeoutMillis)Deprecated.RxtxChannelConfigsetDatabits(RxtxChannelConfig.Databits databits)Deprecated.Sets the number of data bits to use to make up each character sent to the serial device.RxtxChannelConfigsetDtr(boolean dtr)Deprecated.Sets whether the serial device supports the Data Terminal Ready signal, used for flow controlRxtxChannelConfigsetMaxMessagesPerRead(int maxMessagesPerRead)Deprecated.RxtxChannelConfigsetMessageSizeEstimator(io.netty.channel.MessageSizeEstimator estimator)Deprecated.RxtxChannelConfigsetParitybit(RxtxChannelConfig.Paritybit paritybit)Deprecated.Sets the type of parity bit to be used when communicating with the serial device.RxtxChannelConfigsetReadTimeout(int readTimeout)Deprecated.Sets the maximal time (in ms) to block while try to read from the serial port.RxtxChannelConfigsetRecvByteBufAllocator(io.netty.channel.RecvByteBufAllocator allocator)Deprecated.RxtxChannelConfigsetRts(boolean rts)Deprecated.Sets whether the serial device supports the Request To Send signal, used for flow controlRxtxChannelConfigsetStopbits(RxtxChannelConfig.Stopbits stopbits)Deprecated.Sets the number of stop bits to include at the end of every character to aid the serial device in synchronising with the data.RxtxChannelConfigsetWaitTimeMillis(int waitTimeMillis)Deprecated.Sets the time to wait after opening the serial port and before sending it any configuration information or data.RxtxChannelConfigsetWriteBufferHighWaterMark(int writeBufferHighWaterMark)Deprecated.RxtxChannelConfigsetWriteBufferLowWaterMark(int writeBufferLowWaterMark)Deprecated.RxtxChannelConfigsetWriteBufferWaterMark(io.netty.channel.WriteBufferWaterMark writeBufferWaterMark)Deprecated.RxtxChannelConfigsetWriteSpinCount(int writeSpinCount)Deprecated.-
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)
Deprecated.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)
Deprecated.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)
Deprecated.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)
Deprecated.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()
Deprecated.- Returns:
- The configured baud rate, defaulting to 115200 if unset
-
getStopbits
RxtxChannelConfig.Stopbits getStopbits()
Deprecated.- Returns:
- The configured stop bits, defaulting to
RxtxChannelConfig.Stopbits.STOPBITS_1if unset
-
getDatabits
RxtxChannelConfig.Databits getDatabits()
Deprecated.- Returns:
- The configured data bits, defaulting to
RxtxChannelConfig.Databits.DATABITS_8if unset
-
getParitybit
RxtxChannelConfig.Paritybit getParitybit()
Deprecated.- Returns:
- The configured parity bit, defaulting to
RxtxChannelConfig.Paritybit.NONEif unset
-
isDtr
boolean isDtr()
Deprecated.- Returns:
- true if the serial device should support the Data Terminal Ready signal
-
setDtr
RxtxChannelConfig setDtr(boolean dtr)
Deprecated.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()
Deprecated.- Returns:
- true if the serial device should support the Ready to Send signal
-
setRts
RxtxChannelConfig setRts(boolean rts)
Deprecated.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()
Deprecated.- Returns:
- The number of milliseconds to wait between opening the serial port and initialising.
-
setWaitTimeMillis
RxtxChannelConfig setWaitTimeMillis(int waitTimeMillis)
Deprecated.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)
Deprecated.Sets the maximal time (in ms) to block while try to read from the serial port. Default is 1000ms
-
getReadTimeout
int getReadTimeout()
Deprecated.Return the maximal time (in ms) to block and wait for something to be ready to read.
-
setConnectTimeoutMillis
RxtxChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)
Deprecated.- Specified by:
setConnectTimeoutMillisin interfaceio.netty.channel.ChannelConfig
-
setMaxMessagesPerRead
@Deprecated RxtxChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)
Deprecated.- Specified by:
setMaxMessagesPerReadin interfaceio.netty.channel.ChannelConfig
-
setWriteSpinCount
RxtxChannelConfig setWriteSpinCount(int writeSpinCount)
Deprecated.- Specified by:
setWriteSpinCountin interfaceio.netty.channel.ChannelConfig
-
setAllocator
RxtxChannelConfig setAllocator(io.netty.buffer.ByteBufAllocator allocator)
Deprecated.- Specified by:
setAllocatorin interfaceio.netty.channel.ChannelConfig
-
setRecvByteBufAllocator
RxtxChannelConfig setRecvByteBufAllocator(io.netty.channel.RecvByteBufAllocator allocator)
Deprecated.- Specified by:
setRecvByteBufAllocatorin interfaceio.netty.channel.ChannelConfig
-
setAutoRead
RxtxChannelConfig setAutoRead(boolean autoRead)
Deprecated.- Specified by:
setAutoReadin interfaceio.netty.channel.ChannelConfig
-
setAutoClose
RxtxChannelConfig setAutoClose(boolean autoClose)
Deprecated.- Specified by:
setAutoClosein interfaceio.netty.channel.ChannelConfig
-
setWriteBufferHighWaterMark
RxtxChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)
Deprecated.- Specified by:
setWriteBufferHighWaterMarkin interfaceio.netty.channel.ChannelConfig
-
setWriteBufferLowWaterMark
RxtxChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)
Deprecated.- Specified by:
setWriteBufferLowWaterMarkin interfaceio.netty.channel.ChannelConfig
-
setWriteBufferWaterMark
RxtxChannelConfig setWriteBufferWaterMark(io.netty.channel.WriteBufferWaterMark writeBufferWaterMark)
Deprecated.- Specified by:
setWriteBufferWaterMarkin interfaceio.netty.channel.ChannelConfig
-
setMessageSizeEstimator
RxtxChannelConfig setMessageSizeEstimator(io.netty.channel.MessageSizeEstimator estimator)
Deprecated.- Specified by:
setMessageSizeEstimatorin interfaceio.netty.channel.ChannelConfig
-
-