net.solarnetwork.io.modbus.rtu.netty

Class RtuNettyModbusClient

java.lang.Object

net.solarnetwork.io.modbus.netty.handler.NettyModbusClient<RtuModbusClientConfig>

net.solarnetwork.io.modbus.rtu.netty.RtuNettyModbusClient

All Implemented Interfaces:

io.netty.bootstrap.ChannelFactory<net.solarnetwork.io.modbus.netty.serial.SerialPortChannel>, net.solarnetwork.io.modbus.ModbusClient

public class RtuNettyModbusClient
extends net.solarnetwork.io.modbus.netty.handler.NettyModbusClient<RtuModbusClientConfig>
implements io.netty.channel.ChannelFactory<net.solarnetwork.io.modbus.netty.serial.SerialPortChannel>

RTU implementation of ModbusClient.

Nested Class Summary

Nested classes/interfaces inherited from class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient

net.solarnetwork.io.modbus.netty.handler.NettyModbusClient.PendingMessage

Field Summary

Fields inherited from class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient

CLIENT_HANDLER_NAME, clientConfig, DEFAULT_PENDING_MESSAGE_TTL, DEFAULT_REPLY_TIMEOUT, LAST_ENCODED_MESSAGE, log, MESSAGE_DECODER_HANDLER_NAME, MESSAGE_ENCODER_HANDLER_NAME, WIRE_LOGGING_HANDLER_NAME

Constructor Summary

Constructors

Constructor and Description
RtuNettyModbusClient(RtuModbusClientConfig clientConfig, io.netty.channel.EventLoopGroup eventLoopGroup, net.solarnetwork.io.modbus.serial.SerialPortProvider serialPortProvider) Constructor.
RtuNettyModbusClient(RtuModbusClientConfig clientConfig, ScheduledExecutorService scheduler, ConcurrentMap<net.solarnetwork.io.modbus.ModbusMessage,net.solarnetwork.io.modbus.netty.handler.NettyModbusClient.PendingMessage> pending, io.netty.channel.EventLoopGroup eventLoopGroup, net.solarnetwork.io.modbus.serial.SerialPortProvider serialPortProvider) Constructor.
RtuNettyModbusClient(RtuModbusClientConfig clientConfig, ScheduledExecutorService scheduler, io.netty.channel.EventLoopGroup eventLoopGroup, net.solarnetwork.io.modbus.serial.SerialPortProvider serialPortProvider) Constructor.
RtuNettyModbusClient(RtuModbusClientConfig clientConfig, net.solarnetwork.io.modbus.serial.SerialPortProvider serialPortProvider) Constructor.

Method Summary

Modifier and Type	Method and Description
protected io.netty.channel.ChannelFuture	connect()
protected void	initChannel(io.netty.channel.Channel channel)
net.solarnetwork.io.modbus.netty.serial.SerialPortChannel	newChannel()
CompletableFuture<?>	stop()

Methods inherited from class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient

getClientConfig, getConnectionObserver, getPendingMessageTtl, getReplyTimeout, isConnected, isStarted, isWireLogging, newModbusChannelHandler, send, sendAsync, setConnectionObserver, setPendingMessageTtl, setReplyTimeout, setWireLogging, start

Methods inherited from class java.lang.Object

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

Constructor Detail

RtuNettyModbusClient

public RtuNettyModbusClient(RtuModbusClientConfig clientConfig,
                            net.solarnetwork.io.modbus.serial.SerialPortProvider serialPortProvider)

Constructor.

Parameters:

clientConfig - the client configuration

serialPortProvider - the serial port provider

Throws:

IllegalArgumentException - if any argument is null

RtuNettyModbusClient

public RtuNettyModbusClient(RtuModbusClientConfig clientConfig,
                            io.netty.channel.EventLoopGroup eventLoopGroup,
                            net.solarnetwork.io.modbus.serial.SerialPortProvider serialPortProvider)

Constructor.

Parameters:

clientConfig - the client configuration

eventLoopGroup - the event loop group, or null to create an internal one

serialPortProvider - the serial port provider

Throws:

IllegalArgumentException - if any argument except eventLoopGroup is null

RtuNettyModbusClient

public RtuNettyModbusClient(RtuModbusClientConfig clientConfig,
                            ScheduledExecutorService scheduler,
                            io.netty.channel.EventLoopGroup eventLoopGroup,
                            net.solarnetwork.io.modbus.serial.SerialPortProvider serialPortProvider)

Constructor.

Parameters:

clientConfig - the client configuration

scheduler - the scheduler, or null to create an internal one

serialPortProvider - the serial port provider

Throws:

IllegalArgumentException - if any argument except eventLoopGroup is null

RtuNettyModbusClient

public RtuNettyModbusClient(RtuModbusClientConfig clientConfig,
                            ScheduledExecutorService scheduler,
                            ConcurrentMap<net.solarnetwork.io.modbus.ModbusMessage,net.solarnetwork.io.modbus.netty.handler.NettyModbusClient.PendingMessage> pending,
                            io.netty.channel.EventLoopGroup eventLoopGroup,
                            net.solarnetwork.io.modbus.serial.SerialPortProvider serialPortProvider)

Constructor.

Parameters:

clientConfig - the client configuration

scheduler - the scheduler, or null to create an internal one

pending - a map for request messages pending responses

eventLoopGroup - the event loop group, or null to create an internal one

serialPortProvider - the serial port provider

Throws:

IllegalArgumentException - if any argument except eventLoopGroup is null

Method Detail

newChannel

public net.solarnetwork.io.modbus.netty.serial.SerialPortChannel newChannel()

Specified by:

newChannel in interface io.netty.bootstrap.ChannelFactory<net.solarnetwork.io.modbus.netty.serial.SerialPortChannel>

connect

protected io.netty.channel.ChannelFuture connect()
                                          throws IOException

Specified by:

connect in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient<RtuModbusClientConfig>

Throws:

IOException

stop

public CompletableFuture<?> stop()

Specified by:

stop in interface net.solarnetwork.io.modbus.ModbusClient

Overrides:

stop in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient<RtuModbusClientConfig>

initChannel

protected void initChannel(io.netty.channel.Channel channel)

Overrides:

initChannel in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient<RtuModbusClientConfig>