io.netty.channel.rxtx

Interface RxtxChannelConfig

All Superinterfaces:

io.netty.channel.ChannelConfig

public interface RxtxChannelConfig
extends io.netty.channel.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

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(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) Deprecated.
RxtxChannelConfig	setWriteBufferLowWaterMark(int writeBufferLowWaterMark) Deprecated.
RxtxChannelConfig	setWriteBufferWaterMark(io.netty.channel.WriteBufferWaterMark writeBufferWaterMark)
RxtxChannelConfig	setWriteSpinCount(int writeSpinCount)

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 readTimout)

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)

Specified by:

setConnectTimeoutMillis in interface io.netty.channel.ChannelConfig

setMaxMessagesPerRead

@Deprecated
RxtxChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

Deprecated.

Specified by:

setMaxMessagesPerRead in interface io.netty.channel.ChannelConfig

setWriteSpinCount

RxtxChannelConfig setWriteSpinCount(int writeSpinCount)

Specified by:

setWriteSpinCount in interface io.netty.channel.ChannelConfig

setAllocator

RxtxChannelConfig setAllocator(io.netty.buffer.ByteBufAllocator allocator)

Specified by:

setAllocator in interface io.netty.channel.ChannelConfig

setRecvByteBufAllocator

RxtxChannelConfig setRecvByteBufAllocator(io.netty.channel.RecvByteBufAllocator allocator)

Specified by:

setRecvByteBufAllocator in interface io.netty.channel.ChannelConfig

setAutoRead

RxtxChannelConfig setAutoRead(boolean autoRead)

Specified by:

setAutoRead in interface io.netty.channel.ChannelConfig

setAutoClose

RxtxChannelConfig setAutoClose(boolean autoClose)

Specified by:

setAutoClose in interface io.netty.channel.ChannelConfig

setWriteBufferHighWaterMark

@Deprecated
RxtxChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)

Deprecated.

Specified by:

setWriteBufferHighWaterMark in interface io.netty.channel.ChannelConfig

setWriteBufferLowWaterMark

@Deprecated
RxtxChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)

Deprecated.

Specified by:

setWriteBufferLowWaterMark in interface io.netty.channel.ChannelConfig

setWriteBufferWaterMark

RxtxChannelConfig setWriteBufferWaterMark(io.netty.channel.WriteBufferWaterMark writeBufferWaterMark)

Specified by:

setWriteBufferWaterMark in interface io.netty.channel.ChannelConfig

setMessageSizeEstimator

RxtxChannelConfig setMessageSizeEstimator(io.netty.channel.MessageSizeEstimator estimator)

Specified by:

setMessageSizeEstimator in interface io.netty.channel.ChannelConfig