public interface RxtxChannelConfig
extends io.netty.channel.ChannelConfig
ChannelConfig
,
DefaultRxtxChannelConfig
allows the following options in the option map:
Modifier and Type | Interface and Description |
---|---|
static class |
RxtxChannelConfig.Databits |
static class |
RxtxChannelConfig.Paritybit |
static class |
RxtxChannelConfig.Stopbits |
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(io.netty.buffer.ByteBufAllocator allocator) |
RxtxChannelConfig |
setAutoClose(boolean autoClose) |
RxtxChannelConfig |
setAutoRead(boolean autoRead) |
RxtxChannelConfig |
setBaudrate(int baudrate)
Sets the baud rate (ie. bits per second) for communication with the serial device.
|
RxtxChannelConfig |
setConnectTimeoutMillis(int connectTimeoutMillis) |
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(io.netty.channel.MessageSizeEstimator estimator) |
RxtxChannelConfig |
setParitybit(RxtxChannelConfig.Paritybit paritybit)
Sets the type of parity bit to be used when communicating with the serial device.
|
RxtxChannelConfig |
setReadTimeout(int readTimout)
Sets the maximal time (in ms) to block while try to read from the serial port.
|
RxtxChannelConfig |
setRecvByteBufAllocator(io.netty.channel.RecvByteBufAllocator allocator) |
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) |
RxtxChannelConfig |
setWriteBufferLowWaterMark(int writeBufferLowWaterMark) |
RxtxChannelConfig |
setWriteBufferWaterMark(io.netty.channel.WriteBufferWaterMark writeBufferWaterMark) |
RxtxChannelConfig |
setWriteSpinCount(int writeSpinCount) |
getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getOption, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setOption, setOptions
RxtxChannelConfig setBaudrate(int baudrate)
baudrate
- The baud rate (in bits per second)RxtxChannelConfig setStopbits(RxtxChannelConfig.Stopbits stopbits)
stopbits
- The number of stop bits to useRxtxChannelConfig setDatabits(RxtxChannelConfig.Databits databits)
databits
- The number of data bits to useRxtxChannelConfig setParitybit(RxtxChannelConfig.Paritybit paritybit)
paritybit
- The type of parity bit to be usedint getBaudrate()
RxtxChannelConfig.Stopbits getStopbits()
RxtxChannelConfig.Stopbits.STOPBITS_1
if unsetRxtxChannelConfig.Databits getDatabits()
RxtxChannelConfig.Databits.DATABITS_8
if unsetRxtxChannelConfig.Paritybit getParitybit()
RxtxChannelConfig.Paritybit.NONE
if unsetboolean isDtr()
RxtxChannelConfig setDtr(boolean dtr)
dtr
- true if DTR is supported, false otherwiseboolean isRts()
RxtxChannelConfig setRts(boolean rts)
rts
- true if RTS is supported, false otherwiseint getWaitTimeMillis()
RxtxChannelConfig setWaitTimeMillis(int waitTimeMillis)
waitTimeMillis
- The number of milliseconds to wait, defaulting to 0 (no
wait) if unsetIllegalArgumentException
- if the supplied value is < 0RxtxChannelConfig setReadTimeout(int readTimout)
int getReadTimeout()
RxtxChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)
setConnectTimeoutMillis
in interface io.netty.channel.ChannelConfig
@Deprecated RxtxChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)
setMaxMessagesPerRead
in interface io.netty.channel.ChannelConfig
RxtxChannelConfig setWriteSpinCount(int writeSpinCount)
setWriteSpinCount
in interface io.netty.channel.ChannelConfig
RxtxChannelConfig setAllocator(io.netty.buffer.ByteBufAllocator allocator)
setAllocator
in interface io.netty.channel.ChannelConfig
RxtxChannelConfig setRecvByteBufAllocator(io.netty.channel.RecvByteBufAllocator allocator)
setRecvByteBufAllocator
in interface io.netty.channel.ChannelConfig
RxtxChannelConfig setAutoRead(boolean autoRead)
setAutoRead
in interface io.netty.channel.ChannelConfig
RxtxChannelConfig setAutoClose(boolean autoClose)
setAutoClose
in interface io.netty.channel.ChannelConfig
RxtxChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)
setWriteBufferHighWaterMark
in interface io.netty.channel.ChannelConfig
RxtxChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)
setWriteBufferLowWaterMark
in interface io.netty.channel.ChannelConfig
RxtxChannelConfig setWriteBufferWaterMark(io.netty.channel.WriteBufferWaterMark writeBufferWaterMark)
setWriteBufferWaterMark
in interface io.netty.channel.ChannelConfig
RxtxChannelConfig setMessageSizeEstimator(io.netty.channel.MessageSizeEstimator estimator)
setMessageSizeEstimator
in interface io.netty.channel.ChannelConfig
Copyright © 2008–2017 The Netty Project. All rights reserved.