Package org.openremote.agent.protocol.serial

Class SerialIOClient<T>

java.lang.Object

org.openremote.agent.protocol.io.AbstractNettyIOClient<T,JSerialCommDeviceAddress>

org.openremote.agent.protocol.serial.SerialIOClient<T>

All Implemented Interfaces:

IOClient<T>, NettyIOClient<T>

Direct Known Subclasses:

ZWaveSerialIOClient

public class SerialIOClient<T>
extends AbstractNettyIOClient<T,JSerialCommDeviceAddress>

This is a IOClient implementation for serial ports.

Users of this IOClient are responsible for adding encoders for converting messages of type <T> to ByteBuf (see AbstractNettyIOClient.MessageToByteEncoder) and adding decoders to convert from ByteBuf to messages of type <T> and ensuring these decoded messages are passed back to this client via AbstractNettyIOClient.onMessageReceived(T) (see AbstractNettyIOClient.ByteToMessageDecoder and AbstractNettyIOClient.MessageToMessageDecoder).

Nested Class Summary

Nested classes/interfaces inherited from class org.openremote.agent.protocol.io.AbstractNettyIOClient

AbstractNettyIOClient.ByteToMessageDecoder<T>, AbstractNettyIOClient.MessageToByteEncoder<T>, AbstractNettyIOClient.MessageToMessageDecoder<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected int	baudRate
static int	DEFAULT_BAUD_RATE
protected String	port

Fields inherited from class org.openremote.agent.protocol.io.AbstractNettyIOClient

bootstrap, channel, connectionStatus, connectionStatusConsumers, connectRetry, connectTimeout, encoderDecoderProvider, executorService, messageConsumers, RECONNECT_DELAY_INITIAL_MILLIS, RECONNECT_DELAY_MAX_MILLIS, scheduledExecutorService, workerGroup

Constructor Summary

Constructors

Constructor	Description
SerialIOClient(String port, Integer baudRate)

Method Summary

Modifier and Type	Method	Description
protected void	configureChannel()
protected Class<? extends io.netty.channel.Channel>	getChannelClass()
String	getClientUri()	Should return a URI that uniquely identifies this client instance
protected io.netty.channel.EventLoopGroup	getWorkerGroup()
protected Future<Void>	startChannel()	Start the actual connection and return a future indicating completion state.

Methods inherited from class org.openremote.agent.protocol.io.AbstractNettyIOClient

addConnectionStatusConsumer, addEncodersDecoders, addMessageConsumer, connect, disconnect, doConnect, doDisconnect, doReconnect, getConnectionStatus, getConnectTimeoutMillis, initChannel, onConnectionStatusChanged, onDecodeException, onEncodeException, onMessageReceived, removeAllConnectionStatusConsumers, removeAllMessageConsumers, removeConnectionStatusConsumer, removeMessageConsumer, scheduleDoConnect, sendMessage, setConnectTimeoutMillis, setEncoderDecoderProvider, toCompletableFuture, toString, waitForConnectFuture

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

port

protected String port

baudRate

protected int baudRate

DEFAULT_BAUD_RATE

public static int DEFAULT_BAUD_RATE

Constructor Details

SerialIOClient

public SerialIOClient(String port,
 Integer baudRate)

Method Details

getChannelClass

protected Class<? extends io.netty.channel.Channel> getChannelClass()

Specified by:

getChannelClass in class AbstractNettyIOClient<T,JSerialCommDeviceAddress>

startChannel

protected Future<Void> startChannel()

Description copied from class: AbstractNettyIOClient

Start the actual connection and return a future indicating completion state. Implementors can also add any custom connection logic they require.

Specified by:

startChannel in class AbstractNettyIOClient<T,JSerialCommDeviceAddress>

getClientUri

public String getClientUri()

Description copied from interface: IOClient

Should return a URI that uniquely identifies this client instance

getWorkerGroup

protected io.netty.channel.EventLoopGroup getWorkerGroup()

Specified by:

getWorkerGroup in class AbstractNettyIOClient<T,JSerialCommDeviceAddress>

configureChannel

protected void configureChannel()

Overrides:

configureChannel in class AbstractNettyIOClient<T,JSerialCommDeviceAddress>